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 @@ -15,6 +15,7 @@ header:
- '**/*.txt'
- '.codespellignore'
- '.copier-answers.yml'
- 'docs/**'
- '.flake8'
- '.jujuignore'
- '.gitignore'
Expand Down
2 changes: 1 addition & 1 deletion app/doc/tutorial/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

## Requirements

- [pipx installed](https://pipx.pypa.io/stable/installation/)
- [pipx installed](https://pipx.pypa.io/stable/how-to/install-pipx/)
- Apt packages `gcc`, `pipx`, `python3-dev`
- `sudo apt-get install -y python3-dev gcc pipx`
- Working [OpenStack environment](https://microstack.run/docs/single-node)
Expand Down
41 changes: 41 additions & 0 deletions docs/how-to/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
.. meta::
:description: How-to guides for operating the GitHub runner image builder 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 GitHub runner image builder 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 base image <configure-base-image>
Configure build interval <configure-build-interval>
Configure revision history limit <configure-revision-history>
Pin GitHub runner version <pin-github-runner-version>

Update and refresh
------------------

The following guides provide instructions on upgrading your deployment,
including backup and redeployment processes.

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

Upgrade <upgrade>
26 changes: 26 additions & 0 deletions docs/reference/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
.. meta::
:description: Technical reference documentation for the GitHub runner image builder charm, including actions, configurations, and architecture.

.. _reference_index:

Reference
=========

This section contains technical details and information about the GitHub runner image builder charm.

.. vale Canonical.013-Spell-out-numbers-below-10 = NO
.. vale Canonical.500-Repeated-words = NO
.. vale Canonical.004-Canonical-product-names = NO
.. 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