Merge pull request #476 from pavithraes/multiple-instances

Restructure into multiple instances

docs/docs/community/decision-making.md → 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]: /docs/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

docs/docs/community/issues.md → docs/community/issues.md

@@ -47,7 +47,7 @@ If an issue is affecting you, start at the top of this list and complete as many
 
 1. Check the [issue tracker][nebari-issues], if there is an open issue for this same problem, add a reaction or more details to the issue
    to indicate that it’s affecting you (tip: make sure to also check the open [pull requests][nebari-prs] for ongoing work).
-2. You should also check the [troubleshooting guide](../troubleshooting.mdx) in these docs to see if your problem is already listed there.
+2. You should also check the [troubleshooting guide][troubleshooting] in these docs to see if your problem is already listed there.
 3. If there is an open issue, and you can add more detail, write a comment describing how the problem is affecting you,
    OR if you can, write up a work-around or improvement for the issue.
 4. If there is not an issue, write the most complete description of what’s happening including reproduction steps.
@@ -66,7 +66,11 @@ The following actions are typically useful:
 - Linking to related issues or discussions while briefly describing how they are related, for instance “See also #xyz for a similar attempt at this” or “See also #xyz where the same thing happened in another cloud provider" provides context and helps the discussion.
 - Summarizing long discussions on issues to help new and existing contributors quickly understand the background, current status, and course of action for the issue.
 
-<!-- links -->
+<!-- Internal links -->
+
+[troubleshooting]: /docs/troubleshooting
+
+<!-- External Links -->
 
 [nebari-issues]: https://github.com/nebari-dev/nebari/issues
 [nebari-labels]: https://github.com/nebari-dev/nebari/labels

docs/docs/community/maintainers/triage-guidelines.md → docs/community/maintainers/triage-guidelines.md

@@ -129,5 +129,5 @@ Support requests should be directed to the following channels:
 
 [code-contributions]: community/code-contributions.mdx
 [github-conventions]: community/maintainers/github-conventions.md
-[troubleshooting]: ../../troubleshooting.mdx
-[saved-replies]: ./saved-replies.md
+[troubleshooting]: /docs/troubleshooting
+[saved-replies]: community/maintainers/saved-replies.md

docs/docs/community/nebari-tests.md → docs/community/nebari-tests.md

@@ -11,7 +11,7 @@ This page has some tips for testing your contributions to make sure it works as
 
 ### Test CLI manually
 
-If you have an [editable installation of Nebari](code-contributions#install-nebari-in-editable-mode), you can test your changes by running the [Nebari CLI commands](../get-started/quickstart) from within your development environment.
+If you have an [editable installation of Nebari](code-contributions#install-nebari-in-editable-mode), you can test your changes by running the [Nebari CLI commands][quickstart] from within your development environment.
 For example, you can run `nebari init` and make sure it builds the `nebari-config.yaml` file without errors.
 
 ### Test CLI with `pytest`
@@ -80,7 +80,7 @@ It can help you review and resolve day-to-day issues in the deployed clusters qu
 
 You can install `k9s` on macOS, Windows, and Linux with [these instructions project's README](https://github.com/derailed/k9s).
 
-For more details on using `k9s`, check out the [documentation on debugging Nebari](../how-tos/debug-nebari#debugging-the-kubernetes-cluster-using-k9s).
+For more details on using `k9s`, check out the [documentation on debugging Nebari][debugging-nebari].
 
 ### Cloud testing
 
@@ -233,3 +233,8 @@ To get around this, set the `NEBARI_K8S_VERSION` environment variable with:
 ```bash
 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

docs/docs/community/style-guide.md → docs/community/style-guide.md

@@ -30,7 +30,7 @@ Follow your best judgment, and feel free to add to this document following our c
 - **Avoid abbreviations** like "e.g.", "i.e.", and "etc.". Use full words like "for example", "that is", and "and so on" respectively.
 - Use **serial commas**, also known as Oxford comma. For example: "Nebari brand uses purple, yellow, and green."
 - Leave **only one blank space between sentences**.
-- **Break up long lines in code snippets** with "`\`" for better readability. For example, see the code block in [Automatic DNS provision](../how-tos/domain-registry#automatic-dns-provision).
+- **Break up long lines in code snippets** with "`\`" for better readability. For example, see the code block in [Automatic DNS provision][automatic-dns-provision].
 - Try and **use [semantic line breaks](https://sembr.org/)** to help with documentation and contribution reviews.
 - **Prefer American English** over British or other English variant to keep spelling consistency.
 
@@ -99,3 +99,7 @@ For example: "To start JupyterLab, you run `jupyter lab`."
 - The [Microsoft Writing Style Guide](https://learn.microsoft.com/en-gb/style-guide/welcome/) is also a very thorough style guide. The included A-Z word list is a handy reference if you're unsure about a specific term.
 - [Digital Ocean's tutorial style guide](https://www.digitalocean.com/community/tutorials/digitalocean-s-technical-writing-guidelines).
 - [Write the Docs collection of resources for accessible writing](https://www.writethedocs.org/guide/writing/accessibility/).
+
+<!-- Internal links -->
+
+[automatic-dns-provision]: docs/how-tos/domain-registry#automatic-dns-provision

docs/docs/get-started/index.mdx

@@ -0,0 +1,8 @@
+import DocCardList from '@theme/DocCardList';
+import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
+
+# Get Started with Nebari
+
+This section describes how to install and deploy Nebari on a selection of cloud providers, and provides details on how Nebari can be configured and customized to fit a variety of deployment requirements.
+
+<DocCardList items={useCurrentSidebarCategory().items}/>

docs/docs/welcome.mdx

@@ -150,9 +150,9 @@ Learn to perform specific tasks in Nebari, with step-by-step instructions.
 
 Nebari is a community-led open source project, learn how you can get involved!
 
-> [Facing issues with Nebari? Get support on GitHub discussions or the issue tracker →](./community#getting-support)
+> [Facing issues with Nebari? Get support on GitHub discussions or the issue tracker →](/community/introduction#getting-support)
 
-> [Learn how you can contribute to Nebari, beyond code and pull-requests →](./community#how-to-contribute)
+> [Learn how you can contribute to Nebari, beyond code and pull-requests →](/community/introduction#how-to-contribute)
 
 [↳ Read all community resources][community]
 
@@ -180,13 +180,13 @@ Understand technical details of Nebari's architecture and how it works.
 <!-- Internal links -->
 
 [nebari-home]: https://nebari.dev/
-[get-started]: ./category/get-started
-[tutorials]: ./tutorials/
-[how-tos]: ./how-tos/
-[community]: ./community/
-[references]: ./references
-[release-notes]: ./references/RELEASE
-[using-dask]: ./tutorials/using_dask
-[using-vscode]: ./how-tos/using-vscode
-[configure-keycloak]: ./how-tos/configuring-keycloak
-[create-dashboards]: ./tutorials/create-dashboard
+[get-started]: /docs/get-started/
+[tutorials]: /docs/tutorials/
+[how-tos]: /docs/how-tos/
+[community]: /community/introduction
+[references]: /docs/references
+[release-notes]: /docs/references/RELEASE
+[using-dask]: /docs/tutorials/using_dask
+[using-vscode]: /docs/how-tos/using-vscode
+[configure-keycloak]: /docs/how-tos/configuring-keycloak
+[create-dashboards]: /docs/tutorials/create-dashboard

docs/docusaurus.config.js

@@ -46,14 +46,7 @@ const config = {
     defaultLocale: "en",
     locales: ["en"],
   },
-
-  // Plugings need installing first then add here
-  plugins: [
-    "docusaurus-plugin-sass",
-    require.resolve("docusaurus-lunr-search"),
-  ],
-  customFields: { ...customFields },
-
+  // ---------------------------------------------------------------------------
   // Add plausible as script
   scripts: [
     {
@@ -78,7 +71,7 @@ const config = {
           sidebarPath: require.resolve("./sidebars.js"),
           sidebarCollapsible: true,
           // points to the Nebari repo
-          // Remove this to remove the "edit this page" links.\
+          // Remove this to remove the "edit this page" links.
           editUrl: customFields.githubDocsUrl,
           showLastUpdateAuthor: false,
           showLastUpdateTime: true,
@@ -93,6 +86,31 @@ const config = {
       }),
     ],
   ],
+  // ---------------------------------------------------------------------------
+  // Plugins need installing first then add here
+  plugins: [
+    "docusaurus-plugin-sass",
+    require.resolve("docusaurus-lunr-search"),
+    [
+      '@docusaurus/plugin-content-docs',
+      {
+        id: 'community',
+        path: 'community',
+        routeBasePath: 'community',
+        sidebarPath: './sidebarsCommunity.js',
+      },
+    ],
+    [
+      '@docusaurus/plugin-content-docs',
+      {
+        id: 'nebari-slurm',
+        path: 'nebari-slurm',
+        routeBasePath: 'nebari-slurm',
+        sidebarPath: './sidebarsSlurm.js',
+      },
+    ],
+  ],
+  customFields: { ...customFields },
 
   // ---------------------------------------------------------------------------
   themeConfig:
@@ -116,52 +134,61 @@ const config = {
         hideOnScroll: false,
         items: [
           {
-            label: "Home",
-            position: "right",
-            to: "/",
+            label: "Nebari Core",
+            position: "left",
+            to: "/docs/welcome",
+          },
+          {
+            label: "Community",
+            position: "left",
+            to: "community/introduction",
+          },
+          {
+            label: "Nebari Slurm",
+            position: "left",
+            to: "nebari-slurm/overview",
           },
           {
             label: "Get Started",
             position: "right",
+            to: "docs/get-started",
+          },
+          {
+            label: "Ecosystem",
+            position: "right",
             items: [
               {
-                label: "Quickstart",
-                to: "docs/get-started/quickstart",
+                label: "JHub Apps Launcher",
+                href: "https://jhub-apps.nebari.dev",
               },
               {
-                label: "Installing Nebari",
-                to: "docs/get-started/installing-nebari",
+                label: "Jupyter Launchpad",
+                href: "https://github.com/nebari-dev/jupyterlab-new-launcher",
               },
               {
-                label: "Choosing a deployment platform",
-                to: "docs/get-started/deploy",
+                label: "JupyterLab Gallery",
+                href: "https://github.com/nebari-dev/jupyterlab-gallery",
               },
               {
-                label: "Supported cloud providers",
-                to: "docs/get-started/cloud-providers",
+                label: "Plugins and extensions",
+                to: "community/plugins",
               },
-            ],
-          },
-          {
-            label: "Docs",
-            position: "right",
-            to: "/docs/welcome",
-          },
-          {
-            label: "Community",
-            position: "right",
-            to: "docs/community",
+            ]
           },
           {
             label: "GitHub",
             position: "right",
             items: [
               {
-                label: "Code repository",
+                label: "Nebari core code repository",
                 href: customFields.githubCodebaseUrl,
               },
               {
-                label: "Documentation repository",
+                label: "Nebari-Slurm code repository",
+                href: "https://github.com/nebari-dev/nebari-slurm",
+              },
+              {
+                label: "Nebari documentation repository",
                 href: customFields.githubUrl,
               },
             ]

docs/nebari-slurm/overview.mdx

@@ -0,0 +1,10 @@
+# Nebari Slurm - Deploy Nebari on HPC systems
+
+Nebari Slurm is an opinionated open source deployment of JupyterHub based on an HPC jobscheduler.
+Nebari Slurm is a "distribution" of these packages much like Debian and Ubuntu are distributions of Linux.
+The high level goal of this distribution is to form a cohesive set of tools that enable:
+
+* environment management via conda and conda-store
+* monitoring of compute infrastructure and services
+* scalable and efficient compute via jupyterlab and dask
+* deployment of jupyterhub on prem without requiring deep devops knowledge of the Slurm/HPC and jupyter ecosystem

docs/sidebars.js

@@ -22,14 +22,7 @@ module.exports = {
     {
       type: "category",
       label: "Get Started",
-      link: {
-        type: "generated-index",
-        title: "Get started",
-        description:
-          "This section describes how to install and deploy Nebari on a selection of cloud providers, and provides details on how Nebari can be configured and customized to fit a variety of deployment requirements.",
-        slug: "category/get-started",
-        keywords: ["get-started"],
-      },
+      link: { type: "doc", id: "get-started/index" },
       items: [
         "get-started/quickstart",
         "get-started/installing-nebari",
@@ -112,35 +105,6 @@ module.exports = {
         "references/personas"
       ],
     },
-    {
-      type: "category",
-      label: "Community",
-      link: {
-        type: "doc",
-        id: "community/index",
-      },
-      items: [
-        "community/file-issues",
-        "community/code-contributions",
-        "community/nebari-tests",
-        "community/doc-contributions",
-        "community/style-guide",
-        "community/plugins",
-        {
-          type: "category",
-          label: "Maintainers",
-          items: [
-            "community/maintainers/github-conventions",
-            "community/maintainers/triage-guidelines",
-            "community/maintainers/reviewer-guidelines",
-            "community/maintainers/saved-replies",
-            "community/maintainers/release-process-branching-strategy",
-          ],
-        },
-        "community/team-structure",
-        "community/decision-making",
-      ],
-    },
     {
       type: "doc",
       label: "Troubleshooting",
@@ -151,11 +115,5 @@ module.exports = {
       label: "FAQ",
       id: "faq",
     },
-    // TODO - uncomment once populated
-    // {
-    //   type: "doc",
-    //   label: "Glossary",
-    //   id: "glossary",
-    // },
   ],
 };