Merge 6a6269e into edef10c

docs/how-to/configure-runner-storage.md

@@ -11,7 +11,7 @@ This is configured with the [`runner-storage`](https://charmhub.io/github-runner
 
 The random access memory of the juju machine is configured as LXD storage and used as the root disk for the LXD instances.
 
-The `runner-storage` configuration needs to be set to `memory` during deployment, and the juju machine constraints should have enough memory for the virtual machine memory and disk. See [Managing resource usage](https://charmhub.io/github-runner/docs/managing-resource-usage).
+The `runner-storage` configuration needs to be set to `memory` during deployment, and the juju machine constraints should have enough memory for the virtual machine memory and disk. See [Managing resource usage](https://charmhub.io/github-runner/docs/tutorial-managing-resource-usage).
 
 An example deployment:
 

docs/how-to/integrate-with-cos.md

@@ -47,4 +47,4 @@ The `cos-agent` integration can be consumed by the [grafana-agent](https://charm
    ```
 
 You should now be able to access a Grafana Dashboard named `GitHub Self-Hosted Runner Metrics`, displaying metrics, and another named `System Resources` exhibiting host resources in Grafana.
-Additionally, you can explore Loki logs using Grafana's Explore function. For detailed information about the specific metrics in the `GitHub Self-Hosted Runner Metrics` dashboard, refer to [Metrics](https://charmhub.io/github-runner/docs/cos).
+Additionally, you can explore Loki logs using Grafana's Explore function. For detailed information about the specific metrics in the `GitHub Self-Hosted Runner Metrics` dashboard, refer to [Metrics](https://charmhub.io/github-runner/docs/how-to-integrate-with-cos).

docs/how-to/run-on-lxd.md

@@ -10,4 +10,4 @@ To run this charm on LXD, add `virt-type=virtual-machine` to the constraints dur
 juju deploy github-runner --constraints="cores=2 mem=16G virt-type=virtual-machine" --config token=<TOKEN> --config path=<OWNER/REPO>
 ```
 
-This constraint ensures the juju machine hosting the charm is a LXD virtual machine. See [Managing resource usage](https://charmhub.io/github-runner/docs/managing-resource-usage) for recommendation on `cores` and `mem` constraint.
+This constraint ensures the juju machine hosting the charm is a LXD virtual machine. See [Managing resource usage](https://charmhub.io/github-runner/docs/tutorial-managing-resource-usage) for recommendation on `cores` and `mem` constraint.

docs/index.md

@@ -9,21 +9,21 @@ Some of the charm dependencies upgrades on a schedule to migrate security risks.
 
 The charm maintains a set of ephemeral self-hosted runners, each isolated in a single-use virtual machine instance. In addition, resource limits for the self-hosted runners can be configured.
 
-See [charm architecture](https://charmhub.io/github-runner/docs/charm-architecture) for more information.
+See [charm architecture](https://charmhub.io/github-runner/docs/explanation-charm-architecture) for more information.
 
 The charm also supports observability through the optional `cos-agent` integration.
 Metrics and logs about the runners and the charm itself are collected and sent to the [Canonical Observability Stack](https://charmhub.io/topics/canonical-observability-stack) for analysis and visualisation.
 
 This charm will make operating GitHub self-hosted runners simple and straightforward for DevOps or SRE teams through Juju's clean interface.
 
-The charm enforces a set of GitHub repository settings as best practice. This is planned to be opt-in in the future. See [How to comply with repository policies](https://charmhub.io/github-runner/docs/repo-policy).
+The charm enforces a set of GitHub repository settings as best practice. This is planned to be opt-in in the future. See [How to comply with repository policies](https://charmhub.io/github-runner/docs/how-to-repo-policy).
 
 ## In this documentation
 
 | | |
 |--|--|
-|  [Tutorials](https://charmhub.io/github-runner/docs/quick-start)</br>  Get started - a hands-on introduction to using the GitHub runner charm for new users </br> | [How-to guides](https://charmhub.io/github-runner/docs/run-on-lxd) </br> Step-by-step guides covering key operations and common tasks |
-| [Reference](https://charmhub.io/github-runner/docs/actions) </br> Technical information - specifications, APIs, architecture | [Explanation](https://charmhub.io/github-runner/docs/charm-architecture) </br> Concepts - discussion and clarification of key topics  |
+|  [Tutorials](https://charmhub.io/github-runner/docs/tutorial-quick-start)</br>  Get started - a hands-on introduction to using the GitHub runner charm for new users </br> | [How-to guides](https://charmhub.io/github-runner/docs/how-to-change-path) </br> Step-by-step guides covering key operations and common tasks |
+| [Reference](https://charmhub.io/github-runner/docs/reference-actions) </br> Technical information - specifications, APIs, architecture | [Explanation](https://charmhub.io/github-runner/docs/explanation-charm-architecture) </br> Concepts - discussion and clarification of key topics  |
 
 ## Contributing to this documentation
 
@@ -65,4 +65,4 @@ Thinking about using the GitHub runner charm for your next project? [Get in touc
   1. [COS Integration](reference/cos.md)
 1. [Tutorial](tutorial)
   1. [Managing resource usage](tutorial/managing-resource-usage.md)
-  1. [Quick start](tutorial/quick-start.md)
+  1. [Quick start](tutorial/quick-start.md)

docs/tutorial/managing-resource-usage.md

@@ -22,7 +22,7 @@ The recommended combined resource usage is:
 - memory: number of virtual machines * (memory per virtual machine + disk per virtual machine) + 4GiB
 - disk: 20GiB
 
-If memory is used as [runner storage](https://charmhub.io/github-runner/docs/configure-runner-storage):
+If memory is used as [runner storage](https://charmhub.io/github-runner/docs/how-to-configure-runner-storage):
 
 - memory: number of virtual machines * (memory per virtual machine + disk per virtual machine) + 4GiB
 

docs/tutorial/quick-start.md

@@ -45,9 +45,9 @@ juju deploy github-runner --constraints="cores=4 mem=16G root-disk=20G virt-type
 
 Replacing the `<TOKEN>` with the personal access token, and `<OWNER/REPO>` the GitHub account name and GitHub repository separated with `/`.
 
-The `--constraints` option for the `juju deploy` sets the resource requirements for the juju machine hosting the charm application. This is used to accommodate different sizes of self-hosted runners. For details, refer to [Managing resource usage](https://charmhub.io/github-runner/docs/managing-resource-usage).
+The `--constraints` option for the `juju deploy` sets the resource requirements for the juju machine hosting the charm application. This is used to accommodate different sizes of self-hosted runners. For details, refer to [Managing resource usage](https://charmhub.io/github-runner/docs/tutorial-managing-resource-usage).
 
-The `--storage` option mounts a juju storage to be used as the disk for LXD instances hosting the self-hosted runners. Refer [How to configure runner storage](https://charmhub.io/github-runner/docs/configure-runner-storage) for more information.
+The `--storage` option mounts a juju storage to be used as the disk for LXD instances hosting the self-hosted runners. Refer [How to configure runner storage](https://charmhub.io/github-runner/docs/how-to-configure-runner-storage) for more information.
 
 The charm performs various installation and configuration on startup. The charm might upgrade the kernel of the juju machine and reboot the juju machine. During reboot, the juju machine will go into the `down` state, this is a part of the normal reboot process and the juju machine should be restarted after a while.
 
@@ -84,12 +84,12 @@ If the workflow failed at the `Set up runner` step with the following message:
 
 > This job has failed to pass a repository policy compliance check as defined in the https://github.com/canonical/repo-policy-compliance repository. The specific failure is listed below. Please update the settings on this project to fix the relevant policy.
 
-The repository setting does not comply with the best practice enforce by the charm. See [How to comply with repository policies](https://charmhub.io/github-runner/docs/repo-policy).
+The repository setting does not comply with the best practice enforce by the charm. See [How to comply with repository policies](https://charmhub.io/github-runner/docs/how-to-repo-policy).
 
 #### Removing the charm
 
 The charm and the self-hosted runners can be removed with the following command:
 
 ```shell
 juju remove-application github-runner
-```
+```