From e959768fdad3de35688150ce90d55e874e156c3b Mon Sep 17 00:00:00 2001 From: florentianayuwono Date: Tue, 26 May 2026 20:47:16 +0700 Subject: [PATCH] docs: update how-to and reference landing pages - Remove meta-descriptions from all sections - Merge orphan 'Development' section into 'Maintenance and development' - Merge orphan 'Architecture and deployments' into 'Configuration and operations' in reference - Add visible bullet-list links and meaningful section descriptions Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- docs/how-to/index.rst | 27 ++++++++------------------- docs/reference/index.rst | 31 +++++++++++++++++-------------- 2 files changed, 25 insertions(+), 33 deletions(-) diff --git a/docs/how-to/index.rst b/docs/how-to/index.rst index 5c186d2..9091c14 100644 --- a/docs/how-to/index.rst +++ b/docs/how-to/index.rst @@ -6,8 +6,7 @@ How-to guides ============= -The following guides cover key processes and common tasks for managing and -using the aproxy charm. +Manage the aproxy charm through its full operations lifecycle. .. vale Canonical.013-Spell-out-numbers-below-10 = NO .. vale Canonical.500-Repeated-words = NO @@ -15,9 +14,9 @@ using the aproxy charm. 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. +Day-to-day tasks such as configuring proxy settings and integrating with +observability tools keep your aproxy deployment functioning correctly and +connected to the rest of your infrastructure. .. toctree:: :hidden: @@ -26,11 +25,11 @@ basic operations you can complete with the charm. Configure Integrate with COS -Update and refresh ------------------- +Maintenance and development +--------------------------- -The following guides provide instructions on upgrading your deployment, -including backup and restore processes. +Upgrades, back ups, and community contributions ensure the aproxy +charm stays current, reliable, and benefits from ongoing improvements. .. toctree:: :hidden: @@ -38,14 +37,4 @@ including backup and restore processes. 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 index 6844ee1..a040be4 100644 --- a/docs/reference/index.rst +++ b/docs/reference/index.rst @@ -6,37 +6,40 @@ 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. +Technical specifications and architectural details for the aproxy charm serve +as authoritative look-up material when configuring, integrating, or extending +the charm. .. vale Canonical.013-Spell-out-numbers-below-10 = NO .. vale Canonical.500-Repeated-words = NO .. vale Canonical.004-Canonical-product-names = NO +Configuration and operations +---------------------------- + +Operators control charm behaviour through configuration options and Juju +actions. Understanding the charm architecture provides the structural context +needed to see how those settings interact at runtime. + .. toctree:: :hidden: :maxdepth: 1 Actions Configurations - Integrations - Metrics + Charm architecture .. vale Canonical.004-Canonical-product-names = YES -Architecture and deployments ----------------------------- +Connectivity and monitoring +--------------------------- -The following pages provide more details about the charm architecture and -a high-level deployment with any required dependencies. +The aproxy charm communicates with other applications through integrations and +exposes operational metrics to support observability and alerting. .. toctree:: :hidden: :maxdepth: 1 - Charm architecture + Integrations + Metrics