From e959768fdad3de35688150ce90d55e874e156c3b Mon Sep 17 00:00:00 2001 From: florentianayuwono Date: Tue, 26 May 2026 20:47:16 +0700 Subject: [PATCH 1/6] 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 From eff17e86dc7ba35f325bd3fccd19a6bfaa60c44e Mon Sep 17 00:00:00 2001 From: florentianayuwono <76247368+florentianayuwono@users.noreply.github.com> Date: Tue, 26 May 2026 21:49:28 +0700 Subject: [PATCH 2/6] Apply suggestions from code review Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: Erin Conley --- docs/how-to/index.rst | 2 +- docs/reference/index.rst | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/how-to/index.rst b/docs/how-to/index.rst index 9091c14..0fd1ccd 100644 --- a/docs/how-to/index.rst +++ b/docs/how-to/index.rst @@ -28,7 +28,7 @@ connected to the rest of your infrastructure. Maintenance and development --------------------------- -Upgrades, back ups, and community contributions ensure the aproxy +Upgrades, backups, and community contributions ensure the aproxy charm stays current, reliable, and benefits from ongoing improvements. .. toctree:: diff --git a/docs/reference/index.rst b/docs/reference/index.rst index a040be4..897d74c 100644 --- a/docs/reference/index.rst +++ b/docs/reference/index.rst @@ -17,7 +17,7 @@ the charm. Configuration and operations ---------------------------- -Operators control charm behaviour through configuration options and Juju +Operators control charm behavior through configuration options and Juju actions. Understanding the charm architecture provides the structural context needed to see how those settings interact at runtime. @@ -35,7 +35,7 @@ Connectivity and monitoring --------------------------- The aproxy charm communicates with other applications through integrations and -exposes operational metrics to support observability and alerting. +exposes observability metrics to support monitoring and alerting. .. toctree:: :hidden: From 25aed02524a8cc1815438f40904684d740eac9a6 Mon Sep 17 00:00:00 2001 From: florentianayuwono Date: Tue, 26 May 2026 21:50:40 +0700 Subject: [PATCH 3/6] remove hidden --- docs/how-to/index.rst | 2 -- docs/reference/index.rst | 2 -- 2 files changed, 4 deletions(-) diff --git a/docs/how-to/index.rst b/docs/how-to/index.rst index 0fd1ccd..b923fff 100644 --- a/docs/how-to/index.rst +++ b/docs/how-to/index.rst @@ -19,7 +19,6 @@ observability tools keep your aproxy deployment functioning correctly and connected to the rest of your infrastructure. .. toctree:: - :hidden: :maxdepth: 1 Configure @@ -32,7 +31,6 @@ Upgrades, backups, and community contributions ensure the aproxy charm stays current, reliable, and benefits from ongoing improvements. .. toctree:: - :hidden: :maxdepth: 1 Back up and restore diff --git a/docs/reference/index.rst b/docs/reference/index.rst index 897d74c..923bc0b 100644 --- a/docs/reference/index.rst +++ b/docs/reference/index.rst @@ -22,7 +22,6 @@ actions. Understanding the charm architecture provides the structural context needed to see how those settings interact at runtime. .. toctree:: - :hidden: :maxdepth: 1 Actions @@ -38,7 +37,6 @@ The aproxy charm communicates with other applications through integrations and exposes observability metrics to support monitoring and alerting. .. toctree:: - :hidden: :maxdepth: 1 Integrations From 12ac36e5f1c84e1ad77cb83a3abfe849d31a9d55 Mon Sep 17 00:00:00 2001 From: florentianayuwono Date: Wed, 27 May 2026 10:15:51 +0700 Subject: [PATCH 4/6] remove metrics section --- docs/reference/index.rst | 13 ++++++------- docs/reference/metrics.md | 24 ------------------------ 2 files changed, 6 insertions(+), 31 deletions(-) delete mode 100644 docs/reference/metrics.md diff --git a/docs/reference/index.rst b/docs/reference/index.rst index 923bc0b..33b60bb 100644 --- a/docs/reference/index.rst +++ b/docs/reference/index.rst @@ -18,26 +18,25 @@ Configuration and operations ---------------------------- Operators control charm behavior through configuration options and Juju -actions. Understanding the charm architecture provides the structural context -needed to see how those settings interact at runtime. +actions. .. toctree:: :maxdepth: 1 Actions Configurations - Charm architecture .. vale Canonical.004-Canonical-product-names = YES -Connectivity and monitoring +Architecture and design --------------------------- -The aproxy charm communicates with other applications through integrations and -exposes observability metrics to support monitoring and alerting. +The aproxy charm communicates with other applications through integrations. +Understanding the charm architecture provides the structural context +needed to see how those settings interact at runtime. .. toctree:: :maxdepth: 1 + Charm architecture Integrations - Metrics diff --git a/docs/reference/metrics.md b/docs/reference/metrics.md deleted file mode 100644 index 400de84..0000000 --- a/docs/reference/metrics.md +++ /dev/null @@ -1,24 +0,0 @@ -## Metrics - - \ No newline at end of file From 79e30475c2ea032df0be81c6d965aeebfb295f36 Mon Sep 17 00:00:00 2001 From: florentianayuwono Date: Wed, 27 May 2026 10:18:50 +0700 Subject: [PATCH 5/6] remove extra strip --- docs/reference/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/index.rst b/docs/reference/index.rst index 33b60bb..88860d6 100644 --- a/docs/reference/index.rst +++ b/docs/reference/index.rst @@ -29,7 +29,7 @@ actions. .. vale Canonical.004-Canonical-product-names = YES Architecture and design ---------------------------- +----------------------- The aproxy charm communicates with other applications through integrations. Understanding the charm architecture provides the structural context From 7f7ee679e9f3c1b909a7d6932dabe5c5cf5e8836 Mon Sep 17 00:00:00 2001 From: florentianayuwono Date: Wed, 27 May 2026 10:20:56 +0700 Subject: [PATCH 6/6] remove metrics --- docs/index.md | 1 - docs/reference/charm-architecture.md | 12 ------------ 2 files changed, 13 deletions(-) diff --git a/docs/index.md b/docs/index.md index 455cd57..392b88c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -67,7 +67,6 @@ Thinking about using the aproxy operator for your next project? 1. [Actions](reference/actions.md) 1. [Configurations](reference/configurations.md) 1. [Integrations](reference/integrations.md) - 1. [Metrics](reference/metrics.md) 1. [Charm architecture](reference/charm-architecture.md) 1. [Explanation](explanation) 1. [Security](explanation/security.md) diff --git a/docs/reference/charm-architecture.md b/docs/reference/charm-architecture.md index 331ea4b..d0e8c84 100644 --- a/docs/reference/charm-architecture.md +++ b/docs/reference/charm-architecture.md @@ -87,18 +87,6 @@ UpdateRelStyle(snap, upstream, $offsetY="-30", $offsetX="10") This subordinate charm does not use containers or Pebble-managed processes. Instead, it directly manages system resources (snap and nftables) on the host machine. -## Metrics - -To be added in the future. - - - ## Juju events The charm observes the following Juju events: