Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix pages #10

Merged
merged 9 commits into from
Sep 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions docs/extensions/rucio-jupyterlab/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,7 @@ To configure the extension to use `x509` Proxy certificates :
5. Add your Rucio account in the `Account` field.
6. Click on the `Save Settings`, change to the `Explore` tab and start using the extension.

<p align="center">
<img src="../../../images/rucio_ext_x509config.png" />
</p>
![rucio-extension](../../../images/rucio_ext_x509config.png)

:::tip

Expand Down
6 changes: 3 additions & 3 deletions docs/extensions/zenodo-jupyterlab/extension-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,12 @@ The entered access token and choice of whether or not to work within the main or
The sandbox checkbox at the top of the Upload page is readonly and indicates whether of not the user logged in to the main software or the sandbox version. This is to inform the user of in which software their deposit will be made.

In order to continue, the user had to fill in the necessary information:
* Select at least one file to upload (the file browser initially shows the contents of the `$Home` directory in the Jupyter Session)
* Select at least one file to upload (the file browser initially shows the contents of the `$HOME` directory in the Jupyter Session)
* Title
* Select a Resource Type
* Include at least one Creator's name
* Optional Information:
** DOI (otherwise generated automatically)
** Multiple Creators and include affiliations
* DOI (otherwise generated automatically)
* Multiple Creators and include affiliations

Once the `Next` button is selected, a confirmation page is shown with all of the entered information. When `Confirm` is pressed, a deposit is made and the appropriate metadata is assigned. ***Note***: As is currently stands, only the title is able to be set via this mechanism, and the file upload has yet to be implemented.
4 changes: 2 additions & 2 deletions docs/extensions/zenodo-jupyterlab/implementation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ zenodo-jupyterlab-extension/
├── pyproject.toml
├── requirements.txt
├── setup.py
├── src/ #frontend
├── src/ #frontend
│ ├── API/
│ │ ├── API_functions.tsx
│ │ ├── handler.tsx
Expand All @@ -32,7 +32,7 @@ zenodo-jupyterlab-extension/
│ │ ├── build_log.json
│ │ ├── package.json
│ │ └── static/
│ └── server/ #backend
│ └── server/ #backend
│ ├── __init__.py
│ ├── extension.py
│ ├── handlers.py
Expand Down
44 changes: 44 additions & 0 deletions docs/extensions/zenodo-jupyterlab/install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Installation

## For End-Users

The most simple way to download and install the extension is via Docker:
```bash=
docker run -d -p 8888:8888 ghcr.io/vre-hub/zenodo-jupyterlab-extension:<version>
```
All available versions can be found at this [link](https://github.com/vre-hub/zenodo-jupyterlab-extension/pkgs/container/zenodo-jupyterlab-extension).

Now, the instance of Jupyter Lab with the extension installed and enabled should be available on `localhost:8888`.

## For Developers

The following steps require NodeJS >= 20.

Install `yarn`:
```bash=
npm install -g corepack
corepack enable
```

Install Python dependecies:
```bash=
python3 -m pip install -r requirements.txt
````

Install `yarn` dependencies:
```bash=
jlpm
```

Install and Build the Extension:
```bash=
python3 -m pip install -e .
```
Note: the `-e` tag enables editable mode.

Enable the server extension:
```
jupyter server extension enable zenodo_jupyterlab.server
```

Now, open a local instance of Jupyter Lab, and it should be present on the sidebar.