Skip to content

Commit

Permalink
yarn linter
Browse files Browse the repository at this point in the history
  • Loading branch information
@kcpevey
kcpevey committed Sep 24, 2024
1 parent c10f6b9 commit a495364
Showing 1 changed file with 33 additions and 34 deletions.
67 changes: 33 additions & 34 deletions docs/docs/how-tos/jupyter-gallery.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,57 +3,56 @@ title: Share Git Repository via JupyterLab-Gallery
description: Share files or tutorials with your team
---

# How to set up a Git Repository via JupyterLab-Gallery
# How to set up a Git Repository via JupyterLab-Gallery

[JupyterLab-Gallery ](https://github.com/nebari-dev/jupyterlab-gallery) is a JupyterLab plugin
that allows users to share a Git Repository. JupyterLab users are presented with a tile in
the JupyterLab launch screen. Users can choose to download the Gallery.
that allows users to share a Git Repository. JupyterLab users are presented with a tile in
the JupyterLab launch screen. Users can choose to download the Gallery.

By default, if no JupyterLab-Gallery items are added to the config, users will not see this section
in the JupyterLab Launcher.
in the JupyterLab Launcher.

This feature was added to Nebari in the 2024.6.1 release.
This feature was added to Nebari in the 2024.6.1 release.

## Configure JupyterLb-Gallery

In Nebari, the JupyterLab-Gallery configuration is set in the Nebari configuration, `nebari-config.yaml`.
In Nebari, the JupyterLab-Gallery configuration is set in the Nebari configuration, `nebari-config.yaml`.

The configuration is set under the `jupyterlab` section under the subsection `gallery_settings`.
The configuration is set under the `jupyterlab` section under the subsection `gallery_settings`.
Users may set a title for the Gallery section of the Launcher screen and a destination (i.e. folder)
for the location of the cloned repos.
for the location of the cloned repos.

Several repositories can be configured to display as individual gallery tiles. Under the `exhibits`
section, each repository must have a `title` and a `git` location. There are also several other
optional config options.
section, each repository must have a `title` and a `git` location. There are also several other
optional config options.

The configuration is set at two different levels. Top level gallery settings define the title of
the Gallery section and the location in which the repositories are downloaded. The repository
level settings are defined for each repository. The descriptions of each section are described
below.
the Gallery section and the location in which the repositories are downloaded. The repository
level settings are defined for each repository. The descriptions of each section are described
below.

**Top Level Gallery Settings**

| Section | Description |
| ------- | ----------- |
| title | Title on the gallery tile |
| Section | Description |
| ----------- | -------------------------------------------------- |
| title | Title on the gallery tile |
| destination | Location on disk where the repo will be downloaded |


**Repository Level Settings**

| Section | Description |
| ------- | ----------- |
| title | Title on the gallery tile |
| git | URL of the git repository |
| homepage | (Optional) |
| description | Description of the repository to appear on the gallery tile (Optional) |
| icon | base64 encoded image to use an icon to appear on the gallery tile (Optional) |
| account | (Optional) |
| token | Private Access Token to enable access to private repositories (Optional) |
| Section | Description |
| ----------- | ---------------------------------------------------------------------------- |
| title | Title on the gallery tile |
| git | URL of the git repository |
| homepage | (Optional) |
| description | Description of the repository to appear on the gallery tile (Optional) |
| icon | base64 encoded image to use an icon to appear on the gallery tile (Optional) |
| account | (Optional) |
| token | Private Access Token to enable access to private repositories (Optional) |

### Sample configuration

Below is an example of the Gallery settings from the `nebari-config.yaml`.
Below is an example of the Gallery settings from the `nebari-config.yaml`.

```
jupyterlab:
Expand All @@ -80,24 +79,24 @@ jupyterlab:
## Using JupyterLab-Gallery

Once the repositories are configured in the Nebari config and redeployed, all users will have
a section on their JupyterLab Launcher screen for the Gallery.
a section on their JupyterLab Launcher screen for the Gallery.

![JupyterLab Gallery tiles on JupyterLab Launcher screen](/img/how-tos/jupyter-gallery-tiles.png)

Each tile points to a different gallery entry in the configuration. The Gallery repositories
will not be downloaded until users trigger the download for each gallery item. To do so, users
will hover over the tile and click the download button.
will hover over the tile and click the download button.

![JupyterLab Gallery tile on hover for undownloaded repo](/img/how-tos/jupyter-gallery-tile-download.png)

The repository will download to the location specified in the config (in each user's private
space). After the download is complete, hover on the gallery tile present the users with two
new options - the folder icon allows them to jump to the location in the JupyterLab file browser,
The repository will download to the location specified in the config (in each user's private
space). After the download is complete, hover on the gallery tile present the users with two
new options - the folder icon allows them to jump to the location in the JupyterLab file browser,
and the download button allows them to fetch an updated copy of the repo (if available).

![JupyterLab Gallery tile on hover to update repo](/img/how-tos/jupyter-gallery-tile-update.png)

## Conclusion

For more information on the JupyterLab-Gallery project, visit the
[JupyterLab-Gallery codebase repo](https://github.com/nebari-dev/jupyterlab-gallery).
For more information on the JupyterLab-Gallery project, visit the
[JupyterLab-Gallery codebase repo](https://github.com/nebari-dev/jupyterlab-gallery).

0 comments on commit a495364

Please sign in to comment.