From 6adbf771d2b47bf611a66ca896ec60256d22bc83 Mon Sep 17 00:00:00 2001 From: cellarspoon Date: Fri, 21 Jan 2022 13:26:58 +0100 Subject: [PATCH] archiving, laying out menu --- docs/applications/index.md | 3 ++ docs/cli/index.md | 3 ++ docs/get-involved/index.md | 3 ++ docs/maintainers/index.md | 3 ++ docs/operators/index.md | 3 ++ docs/{ => x-archive}/abra.md | 0 docs/{ => x-archive}/app-config-guide.md | 0 docs/{ => x-archive}/apps.md | 0 docs/{ => x-archive}/backup-restore.md | 0 docs/{ => x-archive}/bikemap.md | 0 docs/{ => x-archive}/comm-org.md | 0 docs/{ => x-archive}/config.md | 0 docs/{ => x-archive}/contact.md | 0 docs/{ => x-archive}/contribute.md | 0 docs/{ => x-archive}/credits.md | 0 docs/{ => x-archive}/deploy.md | 0 docs/{ => x-archive}/faq.md | 0 docs/{ => x-archive}/glossary.md | 0 docs/x-archive/index.md | 21 ++++++++++++ docs/{ => x-archive}/managed.md | 0 docs/{ => x-archive}/networking.md | 0 docs/{ => x-archive}/overview.md | 0 .../recipe-maintainer-guide.md | 0 docs/{ => x-archive}/recipe-structure.md | 0 docs/{ => x-archive}/rollback.md | 0 docs/{ => x-archive}/scale.md | 0 docs/{ => x-archive}/secrets.md | 0 docs/{ => x-archive}/server-side.md | 0 docs/{ => x-archive}/strategy.md | 0 docs/{ => x-archive}/troubleshooting.md | 0 mkdocs.yml | 34 ++++--------------- 31 files changed, 42 insertions(+), 28 deletions(-) create mode 100644 docs/applications/index.md create mode 100644 docs/cli/index.md create mode 100644 docs/get-involved/index.md create mode 100644 docs/maintainers/index.md create mode 100644 docs/operators/index.md rename docs/{ => x-archive}/abra.md (100%) rename docs/{ => x-archive}/app-config-guide.md (100%) rename docs/{ => x-archive}/apps.md (100%) rename docs/{ => x-archive}/backup-restore.md (100%) rename docs/{ => x-archive}/bikemap.md (100%) rename docs/{ => x-archive}/comm-org.md (100%) rename docs/{ => x-archive}/config.md (100%) rename docs/{ => x-archive}/contact.md (100%) rename docs/{ => x-archive}/contribute.md (100%) rename docs/{ => x-archive}/credits.md (100%) rename docs/{ => x-archive}/deploy.md (100%) rename docs/{ => x-archive}/faq.md (100%) rename docs/{ => x-archive}/glossary.md (100%) create mode 100644 docs/x-archive/index.md rename docs/{ => x-archive}/managed.md (100%) rename docs/{ => x-archive}/networking.md (100%) rename docs/{ => x-archive}/overview.md (100%) rename docs/{ => x-archive}/recipe-maintainer-guide.md (100%) rename docs/{ => x-archive}/recipe-structure.md (100%) rename docs/{ => x-archive}/rollback.md (100%) rename docs/{ => x-archive}/scale.md (100%) rename docs/{ => x-archive}/secrets.md (100%) rename docs/{ => x-archive}/server-side.md (100%) rename docs/{ => x-archive}/strategy.md (100%) rename docs/{ => x-archive}/troubleshooting.md (100%) diff --git a/docs/applications/index.md b/docs/applications/index.md new file mode 100644 index 0000000..0bda76e --- /dev/null +++ b/docs/applications/index.md @@ -0,0 +1,3 @@ +--- +title: TODO +--- diff --git a/docs/cli/index.md b/docs/cli/index.md new file mode 100644 index 0000000..0bda76e --- /dev/null +++ b/docs/cli/index.md @@ -0,0 +1,3 @@ +--- +title: TODO +--- diff --git a/docs/get-involved/index.md b/docs/get-involved/index.md new file mode 100644 index 0000000..0bda76e --- /dev/null +++ b/docs/get-involved/index.md @@ -0,0 +1,3 @@ +--- +title: TODO +--- diff --git a/docs/maintainers/index.md b/docs/maintainers/index.md new file mode 100644 index 0000000..0bda76e --- /dev/null +++ b/docs/maintainers/index.md @@ -0,0 +1,3 @@ +--- +title: TODO +--- diff --git a/docs/operators/index.md b/docs/operators/index.md new file mode 100644 index 0000000..0bda76e --- /dev/null +++ b/docs/operators/index.md @@ -0,0 +1,3 @@ +--- +title: TODO +--- diff --git a/docs/abra.md b/docs/x-archive/abra.md similarity index 100% rename from docs/abra.md rename to docs/x-archive/abra.md diff --git a/docs/app-config-guide.md b/docs/x-archive/app-config-guide.md similarity index 100% rename from docs/app-config-guide.md rename to docs/x-archive/app-config-guide.md diff --git a/docs/apps.md b/docs/x-archive/apps.md similarity index 100% rename from docs/apps.md rename to docs/x-archive/apps.md diff --git a/docs/backup-restore.md b/docs/x-archive/backup-restore.md similarity index 100% rename from docs/backup-restore.md rename to docs/x-archive/backup-restore.md diff --git a/docs/bikemap.md b/docs/x-archive/bikemap.md similarity index 100% rename from docs/bikemap.md rename to docs/x-archive/bikemap.md diff --git a/docs/comm-org.md b/docs/x-archive/comm-org.md similarity index 100% rename from docs/comm-org.md rename to docs/x-archive/comm-org.md diff --git a/docs/config.md b/docs/x-archive/config.md similarity index 100% rename from docs/config.md rename to docs/x-archive/config.md diff --git a/docs/contact.md b/docs/x-archive/contact.md similarity index 100% rename from docs/contact.md rename to docs/x-archive/contact.md diff --git a/docs/contribute.md b/docs/x-archive/contribute.md similarity index 100% rename from docs/contribute.md rename to docs/x-archive/contribute.md diff --git a/docs/credits.md b/docs/x-archive/credits.md similarity index 100% rename from docs/credits.md rename to docs/x-archive/credits.md diff --git a/docs/deploy.md b/docs/x-archive/deploy.md similarity index 100% rename from docs/deploy.md rename to docs/x-archive/deploy.md diff --git a/docs/faq.md b/docs/x-archive/faq.md similarity index 100% rename from docs/faq.md rename to docs/x-archive/faq.md diff --git a/docs/glossary.md b/docs/x-archive/glossary.md similarity index 100% rename from docs/glossary.md rename to docs/x-archive/glossary.md diff --git a/docs/x-archive/index.md b/docs/x-archive/index.md new file mode 100644 index 0000000..417a30f --- /dev/null +++ b/docs/x-archive/index.md @@ -0,0 +1,21 @@ +--- +title: Co-op Cloud +--- + +Welcome to the Co-op Cloud technical documentation. It's primarily meant for co-ops and other democratic tech collectives already doing libre software hosting who are interested in the project and thinking about doing some alpha testing. + +- New to the project and wondering where to start? Try our [getting started guide](/overview/). + +- Want to see what apps are already available? See the [app catalogue](https://dev.apps.coopcloud.tech). + +- Trying to understand more about the project? See the [the FAQ](/faq/). + +- Interested to learn more about the goals and background of the project? See the [strategy page](/strategy). + +!!! danger "Here be dragons" + + This project is still [alpha quality software](https://en.wikipedia.org/wiki/Software_release_life_cycle#Alpha). Please take that into consideration if you are thinking about using this system in production. We're working hard to make Co-op Cloud stable. In the meantime, this is a good time to help us out with initial testing, feedback, ideas or [join in with development](/contribute/). + +!!! note "Looking for managed Co-op Cloud hosting?" + + If you're looking for a co-operative or tech collective to host digital services for you using the Co-op Cloud, then please see [the managed hosting](/managed/) page for more. diff --git a/docs/managed.md b/docs/x-archive/managed.md similarity index 100% rename from docs/managed.md rename to docs/x-archive/managed.md diff --git a/docs/networking.md b/docs/x-archive/networking.md similarity index 100% rename from docs/networking.md rename to docs/x-archive/networking.md diff --git a/docs/overview.md b/docs/x-archive/overview.md similarity index 100% rename from docs/overview.md rename to docs/x-archive/overview.md diff --git a/docs/recipe-maintainer-guide.md b/docs/x-archive/recipe-maintainer-guide.md similarity index 100% rename from docs/recipe-maintainer-guide.md rename to docs/x-archive/recipe-maintainer-guide.md diff --git a/docs/recipe-structure.md b/docs/x-archive/recipe-structure.md similarity index 100% rename from docs/recipe-structure.md rename to docs/x-archive/recipe-structure.md diff --git a/docs/rollback.md b/docs/x-archive/rollback.md similarity index 100% rename from docs/rollback.md rename to docs/x-archive/rollback.md diff --git a/docs/scale.md b/docs/x-archive/scale.md similarity index 100% rename from docs/scale.md rename to docs/x-archive/scale.md diff --git a/docs/secrets.md b/docs/x-archive/secrets.md similarity index 100% rename from docs/secrets.md rename to docs/x-archive/secrets.md diff --git a/docs/server-side.md b/docs/x-archive/server-side.md similarity index 100% rename from docs/server-side.md rename to docs/x-archive/server-side.md diff --git a/docs/strategy.md b/docs/x-archive/strategy.md similarity index 100% rename from docs/strategy.md rename to docs/x-archive/strategy.md diff --git a/docs/troubleshooting.md b/docs/x-archive/troubleshooting.md similarity index 100% rename from docs/troubleshooting.md rename to docs/x-archive/troubleshooting.md diff --git a/mkdocs.yml b/mkdocs.yml index c7ad968..cd1e02b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,6 +1,6 @@ --- site_author: Co-op Cloud -site_name: Co-op Cloud +site_name: "Co-op Cloud: Public Interest Infrastructure" site_url: https://docs.coopcloud.tech theme: @@ -39,33 +39,11 @@ markdown_extensions: nav: - "Introduction": index.md - - Getting started guide: - - Architecture overview: overview.md - - Deploy your first app: deploy.md - - App catalogue: apps.md - - App config guide: app-config-guide.md - - Recipe maintainer guide: recipe-maintainer-guide.md - - Abra guide: abra.md - - Frequently asked questions: faq.md - - Contributing guide: contribute.md - - Community organising: comm-org.md - - Admin guide: - - How to manage the .abra directory: config.md - - Manage secret data: secrets.md - - Understanding networking: networking.md - - Back-up and restore an app: backup-restore.md - - Scale an app up to handle more traffic: scale.md - - Roll an app back to a previous version: rollback.md - - Running abra on the server: server-side.md - - Glossary: glossary.md - - Under the hood: - - Recipe structure: recipe-structure.md - - Strategy: strategy.md - - Bike map: bikemap.md - - Troubleshooting: troubleshooting.md - - Managed Hosting: managed.md - - Get in touch: contact.md - - Acknowledgements: credits.md + - "Operators Guide": operators/index.md + - "Applications": applications/index.md + - "Get Involved": get-involved/index.md + - "Maintainers Guide": maintainers/index.md + - "CLI Reference": cli/index.md plugins: - search