Merge pull request #503 from nebari-dev/docusaurus_v3

viniciusdc · web-flow · commit 467942a35ba8 · 2024-09-18T15:38:53.000-03:00
Docusaurus v3 upgrade
diff --git a/docs/.eslintrc.json b/docs/.eslintrc.json
diff --git a/docs/community/decision-making.md b/docs/community/decision-making.md
@@ -42,7 +42,7 @@ Minor updates to the codebase and documentation can be discussed in GitHub issue
 
 <!-- Reusable links -->
 
-[nebari-team]: community/team-structure
+[nebari-team]: /community/team-structure
 [core-team]: https://github.com/orgs/nebari-dev/teams/core-team
 [consent-decision-making]: https://www.sociocracyforall.org/consent-decision-making/
 [rfd-issue]: https://github.com/nebari-dev/governance/issues/new?assignees=&labels=type%3A+RFD&projects=&template=RFD.md&title=RFD+-+Title
diff --git a/docs/community/doc-contributions.md b/docs/community/doc-contributions.md
@@ -161,7 +161,7 @@ This command starts a local development server and opens up a browser window.
 Most changes are reflected live without having to restart the server.
 
 :::note
-By default, this will load your site at <http://localhost:3000/>.
+By default, this will load your site at \<http://localhost:3000/\>.
 
 You can specify a different port with `yarn start --port <port-number>`.
 :::
@@ -183,7 +183,7 @@ yarn run serve
 ```
 
 :::note
-By default, this will also load your site at <http://localhost:3000/>.
+By default, this will also load your site at \<http://localhost:3000/\>.
 
 You can specify a different port with `yarn start --port <port-number>`.
 :::
diff --git a/docs/community/introduction.mdx b/docs/community/introduction.mdx
@@ -134,9 +134,7 @@ Our contributing and community guidelines take inspiration from the following pr
 - [Julia Language](https://github.com/JuliaLang/julia/blob/master/CONTRIBUTING.md)
 - [nteract](https://github.com/nteract/nteract/blob/main/CONTRIBUTING.md)
 
-<!-- <DocCardList items={useCurrentSidebarCategory().items} /> -->
-
-<!-- Links -->
+{/*  Links */}
 
 [nebari-issues]: https://github.com/nebari-dev/nebari/issues
 [nebari-prs]: https://github.com/nebari-dev/nebari/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc
@@ -145,7 +143,7 @@ Our contributing and community guidelines take inspiration from the following pr
 [nebari-design]: https://github.com/nebari-dev/nebari-design
 [nebari-governance]: https://github.com/nebari-dev/governance
 
-<!-- Internal links -->
+{/* Internal links  */}
 
 [code-contributions]: community/code-contributions.mdx
 [docs-contributions]: community/doc-contributions.md
diff --git a/docs/community/nebari-tests.md b/docs/community/nebari-tests.md
@@ -45,7 +45,7 @@ After you make changes, you can re-deploy your Nebari instance to test it manual
 
 ### Testing the deployment with `pytest`
 
-The deployment and integration tests help us test various features of a [local Nebari deployment on Kind](#testing-the-nebari-deployment-terraform),
+The deployment and integration tests help us test various features of a [local Nebari deployment on Kind](/docs/how-tos/nebari-local),
 such as Dask Gateway, external integrations, state of the Kubernetes cluster, and more.
 Before you can run these tests, you need to create a test user on your deployment, for example with:
 
@@ -236,5 +236,5 @@ export NEBARI_K8S_VERSION=1.20
 
 <!-- Internal links -->
 
-[quickstart]: docs/get-started/quickstart
-[debugging-nebari]: docs/how-tos/debug-nebari#debugging-the-kubernetes-cluster-using-k9s
+[quickstart]: /docs/get-started/quickstart
+[debugging-nebari]: /docs/how-tos/debug-nebari#debugging-the-kubernetes-cluster-using-k9s
diff --git a/docs/community/style-guide.md b/docs/community/style-guide.md
@@ -102,4 +102,4 @@ For example: "To start JupyterLab, you run `jupyter lab`."
 
 <!-- Internal links -->
 
-[automatic-dns-provision]: docs/how-tos/domain-registry#automatic-dns-provision
+[automatic-dns-provision]: /docs/how-tos/domain-registry#automatic-dns-provision
diff --git a/docs/community/team-structure.md b/docs/community/team-structure.md
@@ -60,6 +60,6 @@ Nebari follows a nomination process to add new team members[^2], as detailed in
 | Team        | Requirements for nomination                                                                                                                   | Nominators                                                     | Approvers                                                                                             |
 | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
 | Triage      | Engage with (create or comment on) one or more issue/PR/discussion in [`nebari-dev`](https://github.com/nebari-dev)                           | Any community member (including self)                          | Any Core team member                                                                                  |
-| Contributor | Two or more [contributions](./#how-to-contribute) to Nebari with intention to continue contributing regularly                                 | Any community member (including self)                          | Any Core team member                                                                                  |
+| Contributor | Two or more [contributions](/community/introduction/#how-to-contribute) to Nebari with intention to continue contributing regularly           | Any community member (including self)                          | Any Core team member                                                                                  |
 | Core        | [Contributors team](#contributors) member with a record of regular, valuable, and high-quality contributions to Nebari for at least one month | Any community member (including self) and one Core team member | Core team makes a [consent-based decision](https://www.sociocracyforall.org/consent-decision-making/) |
 | Conduct     | Member of the Contributor or Core Team with adequate training to handle CoC reports                                                           | Any community member (including self)                          | Core team makes a [consent-based decision](https://www.sociocracyforall.org/consent-decision-making/) |
diff --git a/docs/docs/explanations/advanced-env-configuration.md b/docs/docs/explanations/advanced-env-configuration.md
@@ -8,7 +8,7 @@ description: Configure environments with conda-store
 
 :::tip
 For guidance on managing or creating environments directly with conda-store, see our guide on [Creating new environments on Nebari](/docs/tutorials/creating-new-environments.md).
-If you're looking for information on updating your namespaces after a recent upgrade, refer to our troubleshooting guide on [Migrating namespaces](/docs/troubleshooting.mdx#Conda-store-compatibility-migration-steps).
+If you're looking for information on updating your namespaces after a recent upgrade, refer to our troubleshooting guide on [Migrating namespaces](/docs/troubleshooting.mdx#conda-store-compatibility-migration-steps-when-upgrading-to-045).
 :::
 
 <!-- TODO: Update the time to create environments based in new conda-store updates -->
diff --git a/docs/docs/get-started/quickstart.md b/docs/docs/get-started/quickstart.md
@@ -4,6 +4,9 @@ title: Quickstart
 description: A cheat sheet of Nebari commands for returning users.
 ---
 
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
 This is a quick Nebari CLI reference. If you're new to Nebari, start at [Installing Nebari][install-nebari].
 
 <div align="center">
diff --git a/docs/docs/how-tos/access-logs-loki.md b/docs/docs/how-tos/access-logs-loki.md
@@ -11,7 +11,7 @@ To view the Loki logs via Grafana in Nebari, you'll need to have [set up monitor
 
 ## Getting Started
 
-Access the Monitoring UI for your Nebari installation at https://{your-nebari-domain}/monitoring/.
+Access the Monitoring UI for your Nebari installation at \<https://\{your-nebari-domain\}/monitoring/\>.
 
 :::note
 The **Explore** functionality shown below is only available to users who have `grafana_admin` permissions. In Nebari's default configuration, only the users in the `admin` Keycloak user group will have this role. `grafana_admin` is a client role in Keycloak which can be assigned to other groups or users. See [Configure Keycloak](/docs/how-tos/configuring-keycloak#in-depth-look-at-roles-and-groups) for more information.
diff --git a/docs/docs/how-tos/configure-keycloak-howto.md b/docs/docs/how-tos/configure-keycloak-howto.md
@@ -100,7 +100,7 @@ Steps to create a new user:
 Although not required, users may not be able to log in to Grafana if this field isn't properly set.
 :::
 
-- Associate the user with one or more of the **Groups**. Out of the box, Nebari is deployed with the following groups: `admin`, `developer` and `analyst` (see the [Roles x Groups](#roles-x-groups) section below for more details).
+- Associate the user with one or more of the **Groups**. Out of the box, Nebari is deployed with the following groups: `admin`, `developer` and `analyst` (see the [Roles x Groups](#in-depth-look-at-roles-and-groups) section below for more details).
 
 4. Click **Save**.
 
diff --git a/docs/docs/how-tos/connect-via-ssh.mdx b/docs/docs/how-tos/connect-via-ssh.mdx
@@ -19,7 +19,7 @@ user instances of JupyterLab. The approach described here uses a JupyterHub plug
 
 ## Prepare for the connection on the Nebari deployment
 
-You will create a JupyterHub _token_ in order to access your server remotely. To do this, log into your Nebari deployment and navigate to the JupyterHub token page, <your-nebari-domain.org/hub/token>.
+You will create a JupyterHub _token_ in order to access your server remotely. To do this, log into your Nebari deployment and navigate to the JupyterHub token page, \<your-nebari-domain.org/hub/token\>.
 
 This page is also accessible via the Nebari Home Page:
 
diff --git a/docs/docs/how-tos/debug-nebari.mdx b/docs/docs/how-tos/debug-nebari.mdx
@@ -155,7 +155,8 @@ Once you have installed kubectl, you can use it to debug issues within your Neba
 kubectl provides a variety of commands and options to help you diagnose and fix issues with your deployment.
 In this section, we will cover some useful `kubectl` commands to get you started.
 
-<details><summary>Viewing all pods in a namespace</summary>
+<details>
+<summary>Viewing all pods in a namespace</summary>
 
 To view all the pods in a namespace, use the following command:
 
@@ -168,7 +169,8 @@ to specify the namespace you want to view.
 
 </details>
 
-<details><summary>Viewing all pods in all namespaces</summary>
+<details>
+<summary>Viewing all pods in all namespaces</summary>
 
 To view the logs for a specific pod, use the following command:
 
@@ -187,7 +189,8 @@ refer to [general configuration settings](/docs/explanations/advanced-configurat
 
 </details>
 
-<details><summary>Viewing logs for a specific pod</summary>
+<details>
+<summary>Viewing logs for a specific pod</summary>
 
 ```bash
 kubectl exec -it <pod-name> -n <namespace> -- /bin/bash
diff --git a/docs/docs/how-tos/manual-backup.md b/docs/docs/how-tos/manual-backup.md
@@ -114,8 +114,7 @@ Once this is complete, upload the tar file to S3 using the AWS command-line tool
 aws s3 cp 2021-04-23.tar s3://<your_bucket_name>/backups/2021-04-23.tar
 ```
 
-Replacing `your_bucket_name` with a bucket you have created. If you don't have an existing bucket, instructions are here:
-<https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-bucket-overview.html>
+Replacing `your_bucket_name` with a bucket you have created. If you don't have an existing bucket, check out the [instructions for creating a new bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-bucket-overview.html)
 
 ### Download from object storage and decompress
 
@@ -206,8 +205,7 @@ azcopy copy "https://[account].blob.core.windows.net/[container]/nebari-backups/
 
 ### Digital Ocean
 
-Instructions will be similar to those for AWS above, but use Digital Ocean spaces instead of S3. This guide explains installation of the command-line tool:
-<https://www.digitalocean.com/community/tutorials/how-to-migrate-from-amazon-s3-to-digitalocean-spaces-with-rclone>
+Instructions will be similar to those for AWS above, but use Digital Ocean spaces instead of S3. For more information on command-line tool, check out the [documentation for Digital Ocean Spaces](https://www.digitalocean.com/community/tutorials/how-to-migrate-from-amazon-s3-to-digitalocean-spaces-with-rclone)
 
 ## JupyterHub Database
 
diff --git a/docs/docs/how-tos/nebari-aws.md b/docs/docs/how-tos/nebari-aws.md
@@ -212,7 +212,7 @@ nebari deploy -c nebari-config.yaml
 ```
 
 :::note
-During deployment, Nebari will require you to set a DNS record for the domain defined during [initialize](#nebari-initialize). Follow the instructions on [How to set a DNS record for Nebari][domain-registry] for an overview of the required steps.
+During deployment, Nebari will require you to set a DNS record for the domain defined during [initialize](#initializing-nebari). Follow the instructions on [How to set a DNS record for Nebari][domain-registry] for an overview of the required steps.
 :::
 
 The terminal will prompt you to press <kbd>enter</kbd> to check the authentication credentials that were added as part of the preceding `nebari init` command. Once Nebari is
diff --git a/docs/docs/how-tos/nebari-azure.md b/docs/docs/how-tos/nebari-azure.md
@@ -189,7 +189,7 @@ nebari deploy -c nebari-config.yaml
 ```
 
 :::note
-During deployment, Nebari will require you to set a DNS record for the domain defined during [initialize](#nebari-initialize). Follow the instructions on [How to set a DNS record for Nebari][domain-registry] for an overview of the required steps.
+During deployment, Nebari will require you to set a DNS record for the domain defined during [initialize](#initializing-nebari). Follow the instructions on [How to set a DNS record for Nebari][domain-registry] for an overview of the required steps.
 :::
 
 The terminal will prompt you to press <kbd>enter</kbd> to check the authentication credentials that were added as part of the preceding `nebari init` command. Once Nebari is
diff --git a/docs/docs/how-tos/nebari-do.md b/docs/docs/how-tos/nebari-do.md
@@ -175,7 +175,7 @@ nebari deploy -c nebari-config.yaml
 ```
 
 :::note
-During deployment, Nebari will require you to set a DNS record for the domain defined during [initialize](#nebari-initialize). Follow the instructions on [How to set a DNS record for Nebari][domain-registry] for an overview of the required steps.
+During deployment, Nebari will require you to set a DNS record for the domain defined during [initialize](#initializing-nebari). Follow the instructions on [How to set a DNS record for Nebari][domain-registry] for an overview of the required steps.
 :::
 
 The terminal will prompt you to press <kbd>enter</kbd> to check the authentication credentials that were added as part of the preceding `nebari init` command. Once Nebari is
diff --git a/docs/docs/how-tos/nebari-gcp.md b/docs/docs/how-tos/nebari-gcp.md
@@ -241,7 +241,7 @@ nebari deploy -c nebari-config.yaml
 ```
 
 :::note
-During deployment, Nebari will require you to set a DNS record for the domain defined during [initialize](#nebari-initialize). Follow the instructions on [How to set a DNS record for Nebari][domain-registry] for an overview of the required steps.
+During deployment, Nebari will require you to set a DNS record for the domain defined during [initialize](#initializing-nebari). Follow the instructions on [How to set a DNS record for Nebari][domain-registry] for an overview of the required steps.
 :::
 
 The terminal will prompt you to press <kbd>enter</kbd> to check the authentication credentials that were added as part of the preceding `nebari init` command. Once Nebari is
diff --git a/docs/docs/how-tos/nebari-kubernets.mdx b/docs/docs/how-tos/nebari-kubernets.mdx
@@ -134,7 +134,8 @@ Then update the `nebari-config.yaml` file. The important keys to update are:
 - Replace `amazon_web_services` with `local`
   - And update the `node_selector` and `kube_context` appropriately
 
-<details><summary>Example nebari-config.yaml (Click to expand)</summary>
+<details>
+<summary>Example nebari-config.yaml (Click to expand)</summary>
 
 ```
 project_name: <project_name>
diff --git a/docs/docs/how-tos/nebari-upgrade.md b/docs/docs/how-tos/nebari-upgrade.md
@@ -7,7 +7,7 @@ description: An overview of how to upgrade Nebari. Includes instructions on upda
 # Upgrading Nebari
 
 :::note
-This is a guide to upgrade Nebari to a newer version. If you are migrating from QHub (deprecated) to Nebari, you can find instructions [here](#migrating-from-qhub-to-nebari). If you are updating from an older version of QHub to another version of QHub, those instructions are [here](#upgrade-qhub-from-pre-040-to-another-qhub-version).
+This is a guide to upgrade Nebari to a newer version. If you are migrating from QHub (deprecated) to Nebari, you can find instructions [here](#migrating-from-qhub-deprecated-to-nebari). If you are updating from an older version of QHub to another version of QHub, those instructions are [here](#upgrade-qhub-from-pre-040-to-another-qhub-version).
 :::
 
 ## Upgrade Nebari
@@ -189,7 +189,8 @@ For upgrades from older versions to v0.4, you will need to do the following step
 
 If your QHub deployment relies on Auth0 or GitHub for authentication, please update the OAuth callback URL.
 
-<details><summary>Expand this section for Auth0 instructions </summary>
+<details>
+<summary>Expand this section for Auth0 instructions </summary>
 
 1. Navigate to the your Auth0 tenancy homepage and from there select "Applications".
 
@@ -199,9 +200,10 @@ If your QHub deployment relies on Auth0 or GitHub for authentication, please upd
 
 </details>
 
-<details><summary>Expand this section for GitHub auth instructions </summary>
+<details>
+<summary>Expand this section for GitHub auth instructions </summary>
 
-1. Go to <https://github.com/settings/developers>.
+1. Go to the [GitHub Developer Settings](https://github.com/settings/developers).
 
 2. Click "OAuth Apps" and then click the app representing your Nebari instance.
 
@@ -371,7 +373,8 @@ For upgrades from older versions to v0.4, you will need to do the following step
 
 If your QHub deployment relies on Auth0 or GitHub for authentication, please update the OAuth callback URL.
 
-<details><summary>Expand this section for Auth0 instructions </summary>
+<details>
+<summary>Expand this section for Auth0 instructions </summary>
 
 1. Navigate to the your Auth0 tenancy homepage and from there select "Applications".
 
@@ -381,9 +384,10 @@ If your QHub deployment relies on Auth0 or GitHub for authentication, please upd
 
 </details>
 
-<details><summary>Expand this section for GitHub auth instructions </summary>
+<details>
+<summary>Expand this section for GitHub auth instructions </summary>
 
-1. Go to <https://github.com/settings/developers>.
+1. Go to the [GitHub Developer Settings](https://github.com/settings/developers).
 
 2. Click "OAuth Apps" and then click the app representing your Nebari instance.
 
diff --git a/docs/docs/how-tos/use-gpus.mdx b/docs/docs/how-tos/use-gpus.mdx
@@ -26,7 +26,7 @@ Overview of using GPUs on Nebari including server setup, environment setup, and
 
   If you get the error `nvidia-smi: command not found`, you are most likely on a non-GPU server. Shutdown your server, and start up a GPU-enabled server.
 
-  **Compatible environments for this server must contain CUDA versions *below* the GPU server version. For example, the server in this case is on 12.4. All environments used on this server must contain packages build with CUDA<=12.4.**
+  **Compatible environments for this server must contain CUDA versions *below* the GPU server version. For example, the server in this case is on 12.4. All environments used on this server must contain packages build with `CUDA<=12.4`.**
 
 ## 2. Creating environments
 
@@ -36,7 +36,7 @@ Overview of using GPUs on Nebari including server setup, environment setup, and
   1. **Create the environment specification using `CONDA_OVERRIDE_CUDA` (recommended approach)**:
 
     Conda-store provides an alternate mechanism to enable GPU environments via the setting of an environment variable as explained in the [conda-store docs](https://conda.store/conda-store-ui/tutorials/create-envs#set-environment-variables).
-    While creating a new config, click on the **GUI <-> YAML** Toggle to edit yaml config.
+    While creating a new config, click on the `**GUI <-> YAML**` Toggle to edit yaml config.
     ```
     channels:
       - pytorch
@@ -89,7 +89,7 @@ Please ensure that your choice from PyTorch documentation is not greater than th
     :::note
     The order of the channels is respected by conda, so keep pytorch at the top, then nvidia, then conda-forge.
 
-    You can use **GUI <-> YAML** Toggle to edit the config.
+    You can use `**GUI <-> YAML**` Toggle to edit the config.
 
 
 ## 3. Validating the setup
diff --git a/docs/docs/references/RELEASE.md b/docs/docs/references/RELEASE.md
diff --git a/docs/docs/tutorials/login-with-keycloak.md b/docs/docs/tutorials/login-with-keycloak.md
diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
diff --git a/docs/eslint.config.mjs b/docs/eslint.config.mjs
diff --git a/docs/package.json b/docs/package.json
diff --git a/docs/src/theme/components/navbar.scss b/docs/src/theme/components/navbar.scss
diff --git a/docs/yarn.lock b/docs/yarn.lock

Original file line number	Diff line number	Diff line change
@@ -102,4 +102,4 @@ For example: "To start JupyterLab, you run `jupyter lab`."
`102`	`102`
`103`	`103`	`<!-- Internal links -->`
`104`	`104`
`105`		`-[automatic-dns-provision]: docs/how-tos/domain-registry#automatic-dns-provision`
	`105`	`+[automatic-dns-provision]: /docs/how-tos/domain-registry#automatic-dns-provision`