Skip to content

Re-organize sidebar #598

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Re-organize sidebar #598

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 docs/docs/references/personas.md → docs/community/design/personas.md
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/docs/get-started/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: quickstart
title: Quickstart
title: CLI overview
description: A cheat sheet of Nebari commands for returning users.
---

Expand Down
129 changes: 72 additions & 57 deletions docs/sidebars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -45,55 +34,90 @@ 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",
],
},
{
type: "category",
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",
],
},
{
Expand All @@ -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",
},
],
};
15 changes: 11 additions & 4 deletions docs/sidebarsCommunity.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down