diff --git a/.licenserc.yaml b/.licenserc.yaml index 72b5388..c960196 100644 --- a/.licenserc.yaml +++ b/.licenserc.yaml @@ -26,4 +26,5 @@ header: - 'zap_rules.tsv' - '**/*.md.j2' - 'uv.lock' + - 'docs/**' comment: on-failure diff --git a/docs/changelog.md b/docs/changelog.md index 80b8d9e..7cb4b49 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -10,6 +10,10 @@ Each revision is versioned by the date of the revision. Place any unreleased changes here, that are subject to release in coming versions :). +## 2026-03-05 + +- Add landing pages for how-to and reference section. + ## 2026-02-19 - Update tutorial and add workflow to test the tutorial using Spread. diff --git a/docs/how-to/index.rst b/docs/how-to/index.rst new file mode 100644 index 0000000..5c186d2 --- /dev/null +++ b/docs/how-to/index.rst @@ -0,0 +1,51 @@ +.. meta:: + :description: How-to guides for operating the aproxy charm, including basic operations, upgrades, and development. + +.. _how_to_index: + +How-to guides +============= + +The following guides cover key processes and common tasks for managing and +using the aproxy charm. + +.. vale Canonical.013-Spell-out-numbers-below-10 = NO +.. vale Canonical.500-Repeated-words = NO + +Basic operations +---------------- + +Once you've finished setting up the charm, now you can perform a number +of actions with your deployment. These guides provide instructions on +basic operations you can complete with the charm. + +.. toctree:: + :hidden: + :maxdepth: 1 + + Configure + Integrate with COS + +Update and refresh +------------------ + +The following guides provide instructions on upgrading your deployment, +including backup and restore processes. + +.. toctree:: + :hidden: + :maxdepth: 1 + + Back up and restore + Upgrade + +Development +----------- + +These guides can help you with contributing to the project. + +.. toctree:: + :hidden: + :maxdepth: 1 + + Contribute diff --git a/docs/reference/index.rst b/docs/reference/index.rst new file mode 100644 index 0000000..6844ee1 --- /dev/null +++ b/docs/reference/index.rst @@ -0,0 +1,42 @@ +.. meta:: + :description: Technical reference documentation for the aproxy charm, including actions, configurations, and architecture. + +.. _reference_index: + +Reference +========= + +This section contains technical details and information about the aproxy charm. + +Charm usage +----------- + +The following pages provide more information about the charm's features, +including actions, configurations, and integrations. + +.. vale Canonical.013-Spell-out-numbers-below-10 = NO +.. vale Canonical.500-Repeated-words = NO +.. vale Canonical.004-Canonical-product-names = NO + +.. toctree:: + :hidden: + :maxdepth: 1 + + Actions + Configurations + Integrations + Metrics + +.. vale Canonical.004-Canonical-product-names = YES + +Architecture and deployments +---------------------------- + +The following pages provide more details about the charm architecture and +a high-level deployment with any required dependencies. + +.. toctree:: + :hidden: + :maxdepth: 1 + + Charm architecture