diff --git a/doc/index.md b/doc/index.md index 3094e390f..1d3c515ee 100644 --- a/doc/index.md +++ b/doc/index.md @@ -2,8 +2,7 @@ myst: html_meta: description: MicroCloud is a lightweight, open source cloud platform built on LXD, MicroCeph, and MicroOVN, ideal for private cloud, edge computing, and test labs. -discourse: lxc:[Introducing MicroCloud](15871) -relatedlinks: "[Install MicroCloud on Linux | Snap Store](https://snapcraft.io/microcloud)" +relatedlinks: "[MicroCloud: your open source cloud platform](https://canonical.com/microcloud)" --- (home)= @@ -52,6 +51,17 @@ Also, while each component's documentation includes instructions for removing cl --- +## How this documentation is organized + +This documentation uses the [Diátaxis documentation structure](https://diataxis.fr/). + +- The {ref}`tutorials` introduce you to MicroCloud concepts and usage. +- The {ref}`howto` provide detailed setup and usage instructions, including how to access the UI and manage cluster members. +- The {ref}`reference` guides provide technical details, release notes, and common CLI commands. +- The {ref}`explanation` section includes topic overviews and detailed explanations of key concepts, such as local versus distributed storage. + +--- + ## Project and community MicroCloud is a member of the [Canonical](https://canonical.com) family. It’s an open source project that warmly welcomes community contributions, suggestions, fixes, and constructive feedback. @@ -74,15 +84,12 @@ MicroCloud is a member of the [Canonical](https://canonical.com) family. It’s Thinking about using MicroCloud for your next project? [Get in touch](https://canonical.com/microcloud/contact-us)! - - - ```{toctree} :hidden: :maxdepth: 2 self -Tutorials +/tutorial/index /how-to/index /reference/index /explanation/index