diff --git a/docs/docs/references/personas.md b/docs/community/design/personas.md similarity index 100% rename from docs/docs/references/personas.md rename to docs/community/design/personas.md diff --git a/docs/docs/get-started/quickstart.md b/docs/docs/get-started/quickstart.md index aefe343a..5db24f98 100644 --- a/docs/docs/get-started/quickstart.md +++ b/docs/docs/get-started/quickstart.md @@ -1,6 +1,6 @@ --- id: quickstart -title: Quickstart +title: CLI overview description: A cheat sheet of Nebari commands for returning users. --- diff --git a/docs/sidebars.js b/docs/sidebars.js index 8ba4f898..e634e07e 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -21,18 +21,7 @@ module.exports = { }, { type: "category", - label: "Get Started", - link: { type: "doc", id: "get-started/index" }, - items: [ - "get-started/quickstart", - "get-started/installing-nebari", - "get-started/deploy", - "get-started/cloud-providers", - ], - }, - { - type: "category", - label: "Tutorials", + label: "Usage tutorials", link: { type: "doc", id: "tutorials/index" }, items: [ "tutorials/login-keycloak", @@ -45,39 +34,81 @@ module.exports = { }, { type: "category", - label: "How-to Guides", + label: "Usage how-tos", link: { type: "doc", id: "how-tos/index" }, items: [ - "how-tos/nebari-gcp", - "how-tos/nebari-aws", - "how-tos/nebari-azure", - "how-tos/nebari-kubernetes", - "how-tos/nebari-local", - "how-tos/nebari-stages-directory", - "how-tos/nebari-environment-management", - "how-tos/nebari-destroy", - "how-tos/domain-registry", - "how-tos/debug-nebari", - "how-tos/configuring-keycloak", - "how-tos/configuring-smtp", - "how-tos/using-vscode", - "how-tos/manual-backup", - "how-tos/nebari-upgrade", - "how-tos/kubernetes-version-upgrade", - "how-tos/setup-argo", - "how-tos/using-argo", "how-tos/jhub-app-launcher", - "how-tos/idle-culling", - "how-tos/nebari-extension-system", - "how-tos/telemetry", - "how-tos/setup-monitoring", - "how-tos/setup-healthcheck", - "how-tos/access-logs-loki", + "how-tos/using-vscode", "how-tos/use-gpus", "how-tos/develop-local-packages", "how-tos/install-pip-packages", - "how-tos/fine-grained-permissions", "how-tos/connect-via-ssh", + "how-tos/using-argo", + "how-tos/access-logs-loki", + ], + }, + { + type: "category", + label: "Administration how-tos", + link: { type: "doc", id: "how-tos/index" }, + items: [ + { + type: 'category', + label: 'Initial deployment setup', + items: [ + "get-started/quickstart", + "get-started/installing-nebari", + "how-tos/nebari-environment-management", + "get-started/deploy", + "how-tos/domain-registry", + { + type: 'category', + label: 'Supported cloud providers', + link: { type: 'doc', id: "get-started/cloud-providers" }, + items: [ + "how-tos/nebari-gcp", + "how-tos/nebari-aws", + "how-tos/nebari-azure", + "how-tos/nebari-kubernetes", + "how-tos/nebari-local", + ], + }, + ] + }, + { + type: "category", + label: "Configure Nebari", + items: [ + "how-tos/configuring-keycloak", + "how-tos/fine-grained-permissions", + "explanations/advanced-configuration", + "explanations/security-configuration", + "explanations/provider-configuration", + "explanations/profile-configuration", + "explanations/customize-themes", + "explanations/environments-configuration", + "explanations/custom-overrides-configuration", + "how-tos/configuring-smtp", + "explanations/config-best-practices", + "how-tos/setup-monitoring", + "how-tos/setup-healthcheck", + "how-tos/telemetry", + "how-tos/setup-argo", + ], + }, + { + type: "category", + label: "Maintain Nebari", + items: [ + "how-tos/nebari-upgrade", + "how-tos/kubernetes-version-upgrade", + "how-tos/manual-backup", + "how-tos/debug-nebari", + "how-tos/idle-culling", + "how-tos/nebari-destroy", + ], + }, + "how-tos/nebari-extension-system", ], }, { @@ -85,15 +116,8 @@ module.exports = { label: "Conceptual guides", link: { type: "doc", id: "explanations/index" }, items: [ - "explanations/advanced-configuration", - "explanations/security-configuration", - "explanations/provider-configuration", - "explanations/profile-configuration", - "explanations/customize-themes", - "explanations/environments-configuration", - "explanations/custom-overrides-configuration", - "explanations/config-best-practices", "explanations/infrastructure-architecture", + "how-tos/nebari-stages-directory", ], }, { @@ -102,18 +126,9 @@ module.exports = { link: { type: "doc", id: "references/index" }, items: [ "references/RELEASE", - "references/personas" + "troubleshooting", + "faq", ], }, - { - type: "doc", - label: "Troubleshooting", - id: "troubleshooting", - }, - { - type: "doc", - label: "FAQ", - id: "faq", - }, ], }; diff --git a/docs/sidebarsCommunity.js b/docs/sidebarsCommunity.js index a6d9c471..116e6fd2 100644 --- a/docs/sidebarsCommunity.js +++ b/docs/sidebarsCommunity.js @@ -42,12 +42,19 @@ module.exports = { ], }, { - type: "doc", - id: "team-structure", + type: "category", + label: "Design", + items: [ + "design/personas", + ] }, { - type: "doc", - id: "decision-making", + type: "category", + label: "Governance", + items: [ + "team-structure", + "decision-making", + ] }, { type: "doc",