From a9d3b6286c04873dd721e0c329f9d35acb184342 Mon Sep 17 00:00:00 2001 From: florentianayuwono Date: Mon, 30 Mar 2026 14:59:35 +0700 Subject: [PATCH 1/4] docs: add landing pages --- .licenserc.yaml | 1 + docs/how-to/index.rst | 41 ++++++++++++++++++++++++++++++++++++++++ docs/reference/index.rst | 26 +++++++++++++++++++++++++ 3 files changed, 68 insertions(+) create mode 100644 docs/how-to/index.rst create mode 100644 docs/reference/index.rst diff --git a/.licenserc.yaml b/.licenserc.yaml index d4ff915d..6888b9e8 100644 --- a/.licenserc.yaml +++ b/.licenserc.yaml @@ -15,6 +15,7 @@ header: - '**/*.txt' - '.codespellignore' - '.copier-answers.yml' + - 'docs/**' - '.flake8' - '.jujuignore' - '.gitignore' diff --git a/docs/how-to/index.rst b/docs/how-to/index.rst new file mode 100644 index 00000000..8f285c6a --- /dev/null +++ b/docs/how-to/index.rst @@ -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 build interval + Configure revision history limit + 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 diff --git a/docs/reference/index.rst b/docs/reference/index.rst new file mode 100644 index 00000000..ae000564 --- /dev/null +++ b/docs/reference/index.rst @@ -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 From 316d01931a4604d329916ba749485fb057402b19 Mon Sep 17 00:00:00 2001 From: florentianayuwono Date: Mon, 30 Mar 2026 15:49:35 +0700 Subject: [PATCH 2/4] fix vale error --- docs/how-to/index.rst | 4 ++-- docs/reference/index.rst | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/how-to/index.rst b/docs/how-to/index.rst index 8f285c6a..7189a979 100644 --- a/docs/how-to/index.rst +++ b/docs/how-to/index.rst @@ -1,5 +1,5 @@ .. meta:: - :description: How-to guides for operating the github runner image builder charm, including basic operations, upgrades, and development. + :description: How-to guides for operating the GitHub runner image builder charm, including basic operations, upgrades, and development. .. _how_to_index: @@ -7,7 +7,7 @@ How-to guides ============= The following guides cover key processes and common tasks for managing and -using the github runner image builder charm. +using the GitHub runner image builder charm. .. vale Canonical.013-Spell-out-numbers-below-10 = NO .. vale Canonical.500-Repeated-words = NO diff --git a/docs/reference/index.rst b/docs/reference/index.rst index ae000564..f3312890 100644 --- a/docs/reference/index.rst +++ b/docs/reference/index.rst @@ -1,12 +1,12 @@ .. meta:: - :description: Technical reference documentation for the github runner image builder charm, including actions, configurations, and architecture. + :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. +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 From 5f87b3fa4addc90e0470006f0d10f545f6fc5e79 Mon Sep 17 00:00:00 2001 From: florentianayuwono Date: Mon, 30 Mar 2026 15:51:08 +0700 Subject: [PATCH 3/4] fix github --- docs/how-to/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/how-to/index.rst b/docs/how-to/index.rst index 7189a979..0eff2fe5 100644 --- a/docs/how-to/index.rst +++ b/docs/how-to/index.rst @@ -26,7 +26,7 @@ basic operations you can complete with the charm. Configure base image Configure build interval Configure revision history limit - Pin github runner version + Pin GitHub runner version Update and refresh ------------------ From 25c86324c948ef8bd0429f970f8ae02f35873b8b Mon Sep 17 00:00:00 2001 From: florentianayuwono Date: Mon, 30 Mar 2026 20:54:40 +0700 Subject: [PATCH 4/4] fix link --- app/doc/tutorial/quick-start.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/doc/tutorial/quick-start.md b/app/doc/tutorial/quick-start.md index 532b99b2..9a1ebf26 100644 --- a/app/doc/tutorial/quick-start.md +++ b/app/doc/tutorial/quick-start.md @@ -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)