Skip to content
Merged
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
1 change: 1 addition & 0 deletions .licenserc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,5 @@ header:
- 'zap_rules.tsv'
- '**/*.md.j2'
- 'uv.lock'
- 'docs/**'
comment: on-failure
4 changes: 4 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
51 changes: 51 additions & 0 deletions docs/how-to/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
.. meta::
Comment thread
florentianayuwono marked this conversation as resolved.
: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:
Comment thread
florentianayuwono marked this conversation as resolved.
:maxdepth: 1

Configure <configure>
Integrate with COS <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 <back-up-restore>
Upgrade <upgrade>

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

These guides can help you with contributing to the project.

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

Contribute <contribute>
42 changes: 42 additions & 0 deletions docs/reference/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
.. meta::
Comment thread
florentianayuwono marked this conversation as resolved.
: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

Comment thread
florentianayuwono marked this conversation as resolved.
Actions <actions>
Configurations <configurations>
Integrations <integrations>
Metrics <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 <charm-architecture>
Loading