From fe6dbee9f8c3b0f1b14621e25b48e66fa4861b4b Mon Sep 17 00:00:00 2001 From: Luke Murphy Date: Thu, 18 Feb 2021 11:28:09 +0100 Subject: [PATCH] First stab at a new layout --- docs/contact.md | 9 +++++++++ docs/deploy.md | 5 +++++ docs/getting-started/guide.md | 5 ----- docs/index.md | 13 ++++--------- docs/overview.md | 5 +++++ docs/package.md | 5 +++++ mkdocs.yml | 13 +++++++++++-- 7 files changed, 39 insertions(+), 16 deletions(-) create mode 100644 docs/contact.md create mode 100644 docs/deploy.md delete mode 100644 docs/getting-started/guide.md create mode 100644 docs/overview.md create mode 100644 docs/package.md diff --git a/docs/contact.md b/docs/contact.md new file mode 100644 index 0000000..63fe619 --- /dev/null +++ b/docs/contact.md @@ -0,0 +1,9 @@ +--- +title: Get in Touch +--- + +We're available on the following channels: + +- **Email**: [`helo@autonomic.zone`](mailto:helo@autonomic.zone) +- **Matrix**: [`#coopcloud:autonomic.zone`](https://matrix.to/#/!JSVYWCRXSVMrAzgeKB:autonomic.zone?via=autonomic.zone) +- **Forum**: [`community.coops.tech`](https://community.coops.tech/) diff --git a/docs/deploy.md b/docs/deploy.md new file mode 100644 index 0000000..56e5260 --- /dev/null +++ b/docs/deploy.md @@ -0,0 +1,5 @@ +--- +title: Deploy your first application +--- + +TODO. diff --git a/docs/getting-started/guide.md b/docs/getting-started/guide.md deleted file mode 100644 index b895ede..0000000 --- a/docs/getting-started/guide.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: Getting Started Guide ---- - -WIP diff --git a/docs/index.md b/docs/index.md index 740d000..c86b441 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,12 +2,7 @@ title: A Cooperative Alternative --- -The Cooperative Cloud is a platform built by and for worked-owned technology -cooperatives which proposes a shared social and technical infrastructure for -the operation and management of free software applications. The project was -initiated by [Autonomic]. - -To learn more, please see the [Getting Started guide]. - -[autonomic]: https://autonomic.zone/ -[getting started guide]: getting-started/guide.md +Welcome to the Cooperative Cloud technical documentation! This documentation is +primarily meant for cooperatives and other small service providers already +doing free software hosting who are interested in the project and thinking +about doing some early-adopter testing. diff --git a/docs/overview.md b/docs/overview.md new file mode 100644 index 0000000..9ac58b7 --- /dev/null +++ b/docs/overview.md @@ -0,0 +1,5 @@ +--- +title: Technical overview +--- + +TODO. diff --git a/docs/package.md b/docs/package.md new file mode 100644 index 0000000..d6abeb6 --- /dev/null +++ b/docs/package.md @@ -0,0 +1,5 @@ +--- +title: Package your first application +--- + +TODO. diff --git a/mkdocs.yml b/mkdocs.yml index 5bc0e3e..0d3850a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -6,14 +6,13 @@ site_url: https://cloud.autonomic.zone theme: name: material features: - - navigation.tabs - navigation.instant - toc.integrate palette: primary: light pink accent: purple -copyright: Copyleft © 2021 The Cooperative Cloud +copyright: Copyleft 🄯 2021 The Cooperative Cloud markdown_extensions: - meta @@ -31,6 +30,16 @@ markdown_extensions: emoji_index: !!python/name:materialx.emoji.twemoji emoji_generator: !!python/name:materialx.emoji.to_svg +nav: + - A cooperative alternative: index.md + - Getting started guide: + - Architecture overview: overview.md + - Deploy your first application: deploy.md + - Application catalogue: apps.md + - Tutorials: + - Package your first application: package.md + - Frequently asked questions: faq.md + plugins: - search - awesome-pages