From eab3757dea72a8f0093321cea57b29f9fae4466c Mon Sep 17 00:00:00 2001 From: Kim Pevey Date: Wed, 25 Sep 2024 13:58:21 -0500 Subject: [PATCH] fix token description, add cross references jupyterlab overrides section --- docs/docs/explanations/advanced-custom-settings.md | 2 +- docs/docs/how-tos/jupyter-gallery.md | 7 +++++-- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/docs/explanations/advanced-custom-settings.md b/docs/docs/explanations/advanced-custom-settings.md index 453dd1ec2..52394155e 100644 --- a/docs/docs/explanations/advanced-custom-settings.md +++ b/docs/docs/explanations/advanced-custom-settings.md @@ -155,7 +155,7 @@ jupyterlab: - `jupyterlab.preferred_dir` - Sets the default location in which JupyterLab should open the file browser in. -- `jupyterlab.gallery_settings` - Configures [`jupyterlab-gallery`](https://github.com/nebari-dev/jupyterlab-gallery) extension which enables user to clone (and later synchronise) pre-specified repositories. +- `jupyterlab.gallery_settings` - Configures [`jupyterlab-gallery`](https://github.com/nebari-dev/jupyterlab-gallery) extension which enables user to clone (and later synchronise) pre-specified repositories. See [How to set up a Git Repository via JupyterLab-Gallery](../how-tos/jupyter-gallery) for more detailed information. ```yaml jupyterlab: diff --git a/docs/docs/how-tos/jupyter-gallery.md b/docs/docs/how-tos/jupyter-gallery.md index caf825d88..ef16c4a6d 100644 --- a/docs/docs/how-tos/jupyter-gallery.md +++ b/docs/docs/how-tos/jupyter-gallery.md @@ -52,7 +52,8 @@ below. ### 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`. Note that \ +and \ should be replaced with the actual encoding an Private Access Token, respectively. ``` jupyterlab: @@ -73,7 +74,7 @@ jupyterlab: icon: "data:image/png;base64," git: https://gitlab....net/companyxyz/examples.git account: examples - token: "{{ GITLAB_PAT }}" + token: "" ``` ## Using JupyterLab-Gallery @@ -100,3 +101,5 @@ and the download button allows them to fetch an updated copy of the repo (if ava For more information on the JupyterLab-Gallery project, visit the [JupyterLab-Gallery codebase repo](https://github.com/nebari-dev/jupyterlab-gallery). + +For more information about custom JupyterLab Overrides in the Nebari config, visit the [Custom Overrides Configurations](../explanations/custom-overrides-configuration#jupyterlab) documentation.