From 7c79de41ca15deba8f6278ab11a4c79aa40bc1d7 Mon Sep 17 00:00:00 2001 From: florentianayuwono Date: Thu, 5 Mar 2026 11:57:30 +0700 Subject: [PATCH 1/5] docs: add landing pages --- docs/how-to/index.rst | 50 ++++++++++++++++++++++++++++++++++++++++ docs/reference/index.rst | 41 ++++++++++++++++++++++++++++++++ 2 files changed, 91 insertions(+) create mode 100644 docs/how-to/index.rst create mode 100644 docs/reference/index.rst diff --git a/docs/how-to/index.rst b/docs/how-to/index.rst new file mode 100644 index 0000000..1b9f0b9 --- /dev/null +++ b/docs/how-to/index.rst @@ -0,0 +1,50 @@ +.. 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 + +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..f56fc4d --- /dev/null +++ b/docs/reference/index.rst @@ -0,0 +1,41 @@ +.. 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 + +.. 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 From 7654039d828b1933d7fc71ed059f4c17104d90df Mon Sep 17 00:00:00 2001 From: florentianayuwono Date: Thu, 5 Mar 2026 12:00:01 +0700 Subject: [PATCH 2/5] add changelog --- docs/changelog.md | 4 ++++ 1 file changed, 4 insertions(+) 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. From 56c5f658f94c59203ce21677ac454d2bea05b235 Mon Sep 17 00:00:00 2001 From: florentianayuwono <76247368+florentianayuwono@users.noreply.github.com> Date: Thu, 5 Mar 2026 12:00:43 +0700 Subject: [PATCH 3/5] Apply suggestions from code review Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- docs/how-to/index.rst | 3 +++ docs/reference/index.rst | 3 +++ 2 files changed, 6 insertions(+) diff --git a/docs/how-to/index.rst b/docs/how-to/index.rst index 1b9f0b9..ded5879 100644 --- a/docs/how-to/index.rst +++ b/docs/how-to/index.rst @@ -1,3 +1,6 @@ +.. Copyright 2026 Canonical Ltd. +.. See LICENSE file for licensing details. + .. meta:: :description: How-to guides for operating the aproxy charm, including basic operations, upgrades, and development. diff --git a/docs/reference/index.rst b/docs/reference/index.rst index f56fc4d..dd463d3 100644 --- a/docs/reference/index.rst +++ b/docs/reference/index.rst @@ -1,3 +1,6 @@ +.. Copyright 2026 Canonical Ltd. +.. See LICENSE file for licensing details. + .. meta:: :description: Technical reference documentation for the aproxy charm, including actions, configurations, and architecture. From b9a4018ffb43f3e19e27aad0d90bf55890299d50 Mon Sep 17 00:00:00 2001 From: florentianayuwono Date: Fri, 6 Mar 2026 10:10:57 +0700 Subject: [PATCH 4/5] address reviews --- docs/how-to/index.rst | 3 ++- docs/reference/index.rst | 1 + 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/how-to/index.rst b/docs/how-to/index.rst index ded5879..f8a25d7 100644 --- a/docs/how-to/index.rst +++ b/docs/how-to/index.rst @@ -2,7 +2,7 @@ .. See LICENSE file for licensing details. .. meta:: - :description: How-to guides for operating the aproxy charm, including basic operations, upgrades, and development. + :description: How-to guides for operating the aproxy charm, including basic operations, upgrades, and development. .. _how_to_index: @@ -27,6 +27,7 @@ basic operations you can complete with the charm. :maxdepth: 1 Configure + Integrate with COS Update and refresh ------------------ diff --git a/docs/reference/index.rst b/docs/reference/index.rst index dd463d3..848fa4e 100644 --- a/docs/reference/index.rst +++ b/docs/reference/index.rst @@ -28,6 +28,7 @@ including actions, configurations, and integrations. Actions Configurations Integrations + Metrics .. vale Canonical.004-Canonical-product-names = YES From 6a44c0e5d0226001a670d21424c2932160d603d7 Mon Sep 17 00:00:00 2001 From: florentianayuwono Date: Fri, 6 Mar 2026 10:13:23 +0700 Subject: [PATCH 5/5] remove license --- .licenserc.yaml | 1 + docs/how-to/index.rst | 3 --- docs/reference/index.rst | 3 --- 3 files changed, 1 insertion(+), 6 deletions(-) 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/how-to/index.rst b/docs/how-to/index.rst index f8a25d7..5c186d2 100644 --- a/docs/how-to/index.rst +++ b/docs/how-to/index.rst @@ -1,6 +1,3 @@ -.. Copyright 2026 Canonical Ltd. -.. See LICENSE file for licensing details. - .. meta:: :description: How-to guides for operating the aproxy charm, including basic operations, upgrades, and development. diff --git a/docs/reference/index.rst b/docs/reference/index.rst index 848fa4e..6844ee1 100644 --- a/docs/reference/index.rst +++ b/docs/reference/index.rst @@ -1,6 +1,3 @@ -.. Copyright 2026 Canonical Ltd. -.. See LICENSE file for licensing details. - .. meta:: :description: Technical reference documentation for the aproxy charm, including actions, configurations, and architecture.