From 259f51362b8c49af4b935d9e9b6938584acdbc17 Mon Sep 17 00:00:00 2001 From: Khue Doan Date: Sat, 30 Mar 2024 13:05:37 +0700 Subject: [PATCH] docs: remove empty index pages It seems more confusing without actual content, which can be added on an overview page. Add the new instant load feature as well. --- docs/concepts/index.md | 1 - docs/getting-started/index.md | 1 - docs/how-to-guides/index.md | 1 - docs/how-to-guides/troubleshooting/argocd.md | 3 --- docs/how-to-guides/troubleshooting/cert-manager.md | 3 --- docs/how-to-guides/troubleshooting/gitea.md | 3 --- docs/how-to-guides/troubleshooting/index.md | 1 - docs/installation/index.md | 1 - docs/installation/production/index.md | 1 - docs/reference/architecture/index.md | 1 - docs/reference/index.md | 1 - mkdocs.yml | 14 ++------------ 12 files changed, 2 insertions(+), 29 deletions(-) delete mode 100644 docs/concepts/index.md delete mode 100644 docs/getting-started/index.md delete mode 100644 docs/how-to-guides/index.md delete mode 100644 docs/how-to-guides/troubleshooting/argocd.md delete mode 100644 docs/how-to-guides/troubleshooting/cert-manager.md delete mode 100644 docs/how-to-guides/troubleshooting/gitea.md delete mode 100644 docs/how-to-guides/troubleshooting/index.md delete mode 100644 docs/installation/index.md delete mode 100644 docs/installation/production/index.md delete mode 100644 docs/reference/architecture/index.md delete mode 100644 docs/reference/index.md diff --git a/docs/concepts/index.md b/docs/concepts/index.md deleted file mode 100644 index 74d42e13..00000000 --- a/docs/concepts/index.md +++ /dev/null @@ -1 +0,0 @@ -# Concepts diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md deleted file mode 100644 index 69a5d543..00000000 --- a/docs/getting-started/index.md +++ /dev/null @@ -1 +0,0 @@ -# Getting started diff --git a/docs/how-to-guides/index.md b/docs/how-to-guides/index.md deleted file mode 100644 index 08663ecd..00000000 --- a/docs/how-to-guides/index.md +++ /dev/null @@ -1 +0,0 @@ -# How-to guides diff --git a/docs/how-to-guides/troubleshooting/argocd.md b/docs/how-to-guides/troubleshooting/argocd.md deleted file mode 100644 index fbe2ca98..00000000 --- a/docs/how-to-guides/troubleshooting/argocd.md +++ /dev/null @@ -1,3 +0,0 @@ -# ArgoCD - -TODO (PR welcomed) diff --git a/docs/how-to-guides/troubleshooting/cert-manager.md b/docs/how-to-guides/troubleshooting/cert-manager.md deleted file mode 100644 index 1a3aab14..00000000 --- a/docs/how-to-guides/troubleshooting/cert-manager.md +++ /dev/null @@ -1,3 +0,0 @@ -# cert-manager - -TODO (PR welcomed) diff --git a/docs/how-to-guides/troubleshooting/gitea.md b/docs/how-to-guides/troubleshooting/gitea.md deleted file mode 100644 index ff775230..00000000 --- a/docs/how-to-guides/troubleshooting/gitea.md +++ /dev/null @@ -1,3 +0,0 @@ -# Gitea - -TODO (PR welcomed) diff --git a/docs/how-to-guides/troubleshooting/index.md b/docs/how-to-guides/troubleshooting/index.md deleted file mode 100644 index 4f341277..00000000 --- a/docs/how-to-guides/troubleshooting/index.md +++ /dev/null @@ -1 +0,0 @@ -# Troubleshooting diff --git a/docs/installation/index.md b/docs/installation/index.md deleted file mode 100644 index 25267fe2..00000000 --- a/docs/installation/index.md +++ /dev/null @@ -1 +0,0 @@ -# Installation diff --git a/docs/installation/production/index.md b/docs/installation/production/index.md deleted file mode 100644 index fae4ea32..00000000 --- a/docs/installation/production/index.md +++ /dev/null @@ -1 +0,0 @@ -# Production diff --git a/docs/reference/architecture/index.md b/docs/reference/architecture/index.md deleted file mode 100644 index c79bec1a..00000000 --- a/docs/reference/architecture/index.md +++ /dev/null @@ -1 +0,0 @@ -# Architecture diff --git a/docs/reference/index.md b/docs/reference/index.md deleted file mode 100644 index cf5aa074..00000000 --- a/docs/reference/index.md +++ /dev/null @@ -1 +0,0 @@ -# Reference diff --git a/mkdocs.yml b/mkdocs.yml index 6d9a46dc..e65af92e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -11,7 +11,8 @@ theme: palette: primary: black features: - - navigation.indexes + - navigation.expand + - navigation.instant - navigation.sections - search.highlight - search.share @@ -38,28 +39,23 @@ markdown_extensions: nav: - Home: index.md - Installation: - - installation/index.md - installation/sandbox.md - Production: - - installation/production/index.md - installation/production/prerequisites.md - installation/production/external-resources.md - installation/production/configuration.md - installation/production/deployment.md - installation/post-installation.md - Getting started: - - getting-started/index.md - getting-started/user-onboarding.md - getting-started/install-pre-commit-hooks.md - Concepts: - - concepts/index.md - concepts/pxe-boot.md - concepts/secrets-management.md - concepts/certificate-management.md - concepts/tools-container.md - concepts/testing.md - How-to guides: - - how-to-guides/index.md - how-to-guides/alternate-dns-setup.md - how-to-guides/expose-services-to-the-internet.md - how-to-guides/use-both-github-and-gitea.md @@ -70,15 +66,9 @@ nav: - how-to-guides/media-management.md - how-to-guides/updating-documentation.md - Troubleshooting: - - how-to-guides/troubleshooting/index.md - - how-to-guides/troubleshooting/argocd.md - - how-to-guides/troubleshooting/cert-manager.md - - how-to-guides/troubleshooting/gitea.md - how-to-guides/troubleshooting/pxe-boot.md - Reference: - - reference/index.md - Architecture: - - reference/architecture/index.md - reference/architecture/overview.md - reference/architecture/networking.md - reference/architecture/decision-records.md