From a610db7192604c95d0f5f421f210f602f2b6762c Mon Sep 17 00:00:00 2001 From: DavHau Date: Wed, 17 Jan 2024 13:46:59 +0700 Subject: [PATCH] docs: categorize via sub-directories for inclusion in website --- docs/{ => _internal}/use-cases/01-self-host.md | 0 docs/{ => _internal}/use-cases/02-join-network.md | 0 .../use-cases/03-maintaining-clan-modules.md | 0 docs/{ => _internal}/use-cases/_template.md | 0 docs/admins/_index.md | 10 ++++++++++ docs/{ => admins}/clan-config.md | 0 docs/{ => admins}/machines.md | 0 docs/{ => admins}/quickstart.md | 0 docs/{ => admins}/secrets-management.md | 0 docs/{ => admins}/zerotier.md | 0 docs/{ => contributing}/api-guidelines.md | 0 docs/{ => contributing}/contributing.md | 4 +--- docs/{ => contributing}/testing.md | 0 13 files changed, 11 insertions(+), 3 deletions(-) rename docs/{ => _internal}/use-cases/01-self-host.md (100%) rename docs/{ => _internal}/use-cases/02-join-network.md (100%) rename docs/{ => _internal}/use-cases/03-maintaining-clan-modules.md (100%) rename docs/{ => _internal}/use-cases/_template.md (100%) create mode 100644 docs/admins/_index.md rename docs/{ => admins}/clan-config.md (100%) rename docs/{ => admins}/machines.md (100%) rename docs/{ => admins}/quickstart.md (100%) rename docs/{ => admins}/secrets-management.md (100%) rename docs/{ => admins}/zerotier.md (100%) rename docs/{ => contributing}/api-guidelines.md (100%) rename docs/{ => contributing}/contributing.md (96%) rename docs/{ => contributing}/testing.md (100%) diff --git a/docs/use-cases/01-self-host.md b/docs/_internal/use-cases/01-self-host.md similarity index 100% rename from docs/use-cases/01-self-host.md rename to docs/_internal/use-cases/01-self-host.md diff --git a/docs/use-cases/02-join-network.md b/docs/_internal/use-cases/02-join-network.md similarity index 100% rename from docs/use-cases/02-join-network.md rename to docs/_internal/use-cases/02-join-network.md diff --git a/docs/use-cases/03-maintaining-clan-modules.md b/docs/_internal/use-cases/03-maintaining-clan-modules.md similarity index 100% rename from docs/use-cases/03-maintaining-clan-modules.md rename to docs/_internal/use-cases/03-maintaining-clan-modules.md diff --git a/docs/use-cases/_template.md b/docs/_internal/use-cases/_template.md similarity index 100% rename from docs/use-cases/_template.md rename to docs/_internal/use-cases/_template.md diff --git a/docs/admins/_index.md b/docs/admins/_index.md new file mode 100644 index 000000000..7f15c05cb --- /dev/null +++ b/docs/admins/_index.md @@ -0,0 +1,10 @@ ++++ +title = "Admin Documentation" +description = "Documentation administrators creating or managing cLANs" +date = 2025-05-01T19:00:00+00:00 +updated = 2021-05-01T19:00:00+00:00 +template = "docs/section.html" +weight = 15 +sort_by = "title" +draft = false ++++ diff --git a/docs/clan-config.md b/docs/admins/clan-config.md similarity index 100% rename from docs/clan-config.md rename to docs/admins/clan-config.md diff --git a/docs/machines.md b/docs/admins/machines.md similarity index 100% rename from docs/machines.md rename to docs/admins/machines.md diff --git a/docs/quickstart.md b/docs/admins/quickstart.md similarity index 100% rename from docs/quickstart.md rename to docs/admins/quickstart.md diff --git a/docs/secrets-management.md b/docs/admins/secrets-management.md similarity index 100% rename from docs/secrets-management.md rename to docs/admins/secrets-management.md diff --git a/docs/zerotier.md b/docs/admins/zerotier.md similarity index 100% rename from docs/zerotier.md rename to docs/admins/zerotier.md diff --git a/docs/api-guidelines.md b/docs/contributing/api-guidelines.md similarity index 100% rename from docs/api-guidelines.md rename to docs/contributing/api-guidelines.md diff --git a/docs/contributing.md b/docs/contributing/contributing.md similarity index 96% rename from docs/contributing.md rename to docs/contributing/contributing.md index 3ac914e08..28d0f4558 100644 --- a/docs/contributing.md +++ b/docs/contributing/contributing.md @@ -1,6 +1,4 @@ -# Website Template - -Welcome to our website template repository! This template is designed to help you and your team build high-quality websites efficiently. We've carefully chosen the technologies to make development smooth and enjoyable. Here's what you can expect from this template: +# Contributing **Frontend**: Our frontend is powered by [React NextJS](https://nextjs.org/), a popular and versatile framework for building web applications. diff --git a/docs/testing.md b/docs/contributing/testing.md similarity index 100% rename from docs/testing.md rename to docs/contributing/testing.md