Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 8 additions & 19 deletions docs/how-to/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,17 @@
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

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:
Expand All @@ -26,26 +25,16 @@ basic operations you can complete with the charm.
Configure <configure>
Integrate with COS <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:
:maxdepth: 1

Back up and restore <back-up-restore>
Upgrade <upgrade>

Development
-----------

These guides can help you with contributing to the project.

.. toctree::
:hidden:
:maxdepth: 1

Contribute <contribute>
31 changes: 17 additions & 14 deletions docs/reference/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <actions>
Configurations <configurations>
Integrations <integrations>
Metrics <metrics>
Charm architecture <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 <charm-architecture>
Integrations <integrations>
Metrics <metrics>
Loading