modified: docs/how-to/contribute.md,docs/how-to/deploy-on-arm64.md,do…

…cs/reference/configurations.md,docs/reference/cos.md,docs/tutorial/quick-start.md,docs/tutorial/managing-resource-usage.md,docs/reference/arm64.md,docs/explanation/arm64.md,docs/how-to/change-path.md,docs/how-to/run-on-lxd.md,docs/explanation/charm-architecture.md,docs/index.md,docs/how-to/integrate-with-cos.md,docs/how-to/repo-policy.md,docs/how-to/change-token.md,docs/how-to/configure-denylist.md,docs/reference/actions.md (#182) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: yhaliaw <[email protected]>
canonical · Jan 15, 2024 · 4fc414d · 4fc414d
1 parent 41fa738
commit 4fc414d
Show file tree

Hide file tree

Showing 17 changed files with 40 additions and 16 deletions.
diff --git a/docs/explanation/arm64.md b/docs/explanation/arm64.md
@@ -22,4 +22,4 @@ to be further developed.
 - Kernel (KVM): upstream not yet ready
 - Userspace programs (e.g. qemu): unsupported.
 
-Therefore, it is currently necessary that the charm is deployed on a bare metal instance.
+Therefore, it is currently necessary that the charm is deployed on a bare metal instance.
diff --git a/docs/explanation/charm-architecture.md b/docs/explanation/charm-architecture.md
@@ -104,4 +104,4 @@ into the file `/var/log/github-runner-metrics.log`. For comprehensive details, p
 pertinent [specification](https://discourse.charmhub.io/t/specification-isd075-github-runner-cos-integration/12084).
 
 Subsequently, the `grafana-agent` transmits this log file to Loki, facilitating access for Grafana's visualisation capabilities.
-Notably, most events are transmitted during reconciliation. This approach prioritises long-term monitoring over real-time updates, aligning with the intended monitoring objectives.
+Notably, most events are transmitted during reconciliation. This approach prioritises long-term monitoring over real-time updates, aligning with the intended monitoring objectives.
diff --git a/docs/how-to/change-path.md b/docs/how-to/change-path.md
@@ -6,4 +6,4 @@ By using [`juju config`](https://juju.is/docs/juju/juju-config) to change the [c
 
 ```shell
 juju config <APP_NAME> path=<PATH>
-```
+```
diff --git a/docs/how-to/change-token.md b/docs/how-to/change-token.md
@@ -19,4 +19,4 @@ By using [`juju config`](https://juju.is/docs/juju/juju-config) to change the [c
 
 ```shell
 juju config <APP_NAME> token=<TOKEN>
-```
+```
diff --git a/docs/how-to/configure-denylist.md b/docs/how-to/configure-denylist.md
@@ -21,4 +21,4 @@ This can be employed to prevent self-hosted runners from accessing the network o
 - 233.252.0.0/24
 - 240.0.0.0/4
 
-Additionally, include any IPv4 address or CIDR block that the runner should not have access to on the denylist.
+Additionally, include any IPv4 address or CIDR block that the runner should not have access to on the denylist.
diff --git a/docs/how-to/contribute.md b/docs/how-to/contribute.md
@@ -29,4 +29,4 @@ To test the charm, unit test can be ran with `tox -e unit` and the integration t
 
 ## Canonical Contributor Agreement
 
-Canonical welcomes contributions to the GitHub Runner Operator. Please check out our [contributor agreement](https://ubuntu.com/legal/contributors) if you’re interested in contributing to the solution.
+Canonical welcomes contributions to the GitHub Runner Operator. Please check out our [contributor agreement](https://ubuntu.com/legal/contributors) if you’re interested in contributing to the solution.
diff --git a/docs/how-to/deploy-on-arm64.md b/docs/how-to/deploy-on-arm64.md
@@ -27,4 +27,4 @@ the Unit may become lost for a few minutes. This is an expected behavior and the
 automatically re-register itself onto the Juju controller after a successful reboot.
 
 Goto the repository > Settings (tab) > Actions (left menu dropdown) > Runners and verify that the
-runner has successfully registered and is online.
+runner has successfully registered and is online.
diff --git a/docs/how-to/integrate-with-cos.md b/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/cos).
diff --git a/docs/how-to/repo-policy.md b/docs/how-to/repo-policy.md
@@ -18,4 +18,4 @@ With these settings, the common workflow of creating branches with pull requests
 
 ### Working with outside collaborators
 
-Contributions from outside collaborators (in the case where a repository is public) need to be handled slightly differently. As such, this charm requires pull requests by outside collaborators to be reviewed by someone with `write` permission or above. Once the review is completed, the reviewer should add a comment including the following string: `/canonical/self-hosted-runners/run-workflows <commit SHA>`, where `<commit SHA>` is the commit SHA of the approved commit. Once posted, the self-hosted runners will run the workflow for this commit.
+Contributions from outside collaborators (in the case where a repository is public) need to be handled slightly differently. As such, this charm requires pull requests by outside collaborators to be reviewed by someone with `write` permission or above. Once the review is completed, the reviewer should add a comment including the following string: `/canonical/self-hosted-runners/run-workflows <commit SHA>`, where `<commit SHA>` is the commit SHA of the approved commit. Once posted, the self-hosted runners will run the workflow for this commit.
diff --git a/docs/how-to/run-on-lxd.md b/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/managing-resource-usage) for recommendation on `cores` and `mem` constraint.
diff --git a/docs/index.md b/docs/index.md
@@ -41,3 +41,27 @@ The GitHub runner charm is a member of the Ubuntu family. It's an open-source pr
 - [Contribute](Contribute)
 
 Thinking about using the GitHub runner charm for your next project? [Get in touch](https://chat.charmhub.io/charmhub/channels/charm-dev)!
+
+# Contents
+
+1. [Explanation](explanation)
+  1. [ARM64](explanation/arm64.md)
+  1. [Charm architecture](explanation/charm-architecture.md)
+1. [How To](how-to)
+  1. [How to change repository or organization](how-to/change-path.md)
+  1. [How to change GitHub personal access token](how-to/change-token.md)
+  1. [How to comply with security requirements](how-to/comply-security.md)
+  1. [How to restrict self-hosted runner network access](how-to/configure-denylist.md)
+  1. [How to contribute](how-to/contribute.md)
+  1. [How to deploy on ARM64](how-to/deploy-on-arm64.md)
+  1. [How to integrate with COS](how-to/integrate-with-cos.md)
+  1. [How to comply with repository policies](how-to/repo-policy.md)
+  1. [How to run on LXD cloud](how-to/run-on-lxd.md)
+1. [Reference](reference)
+  1. [Actions](reference/actions.md)
+  1. [ARM64](reference/arm64.md)
+  1. [Configurations](reference/configurations.md)
+  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)
diff --git a/docs/reference/actions.md b/docs/reference/actions.md
@@ -1,3 +1,3 @@
 # Actions
 
-See [Actions](https://charmhub.io/github-runner/actions).
+See [Actions](https://charmhub.io/github-runner/actions).
diff --git a/docs/reference/arm64.md b/docs/reference/arm64.md
@@ -3,4 +3,4 @@
 ### AWS bare metal instances
 
 Use any of the [ARM64 metal instances](https://aws.amazon.com/ec2/instance-types/) to provide juju
-with ARM64 bare metal instances. Some of the examples include: a1.metal, m7g.metal.
+with ARM64 bare metal instances. Some of the examples include: a1.metal, m7g.metal.
diff --git a/docs/reference/configurations.md b/docs/reference/configurations.md
@@ -1,3 +1,3 @@
 # Configurations
 
-See [Configure](https://charmhub.io/github-runner/configure).
+See [Configure](https://charmhub.io/github-runner/configure).
diff --git a/docs/reference/cos.md b/docs/reference/cos.md
@@ -36,4 +36,4 @@ The `grafana-agent` autonomously transmits machine host metrics, which are visua
 
 ## Logs
 
-The `grafana-agent` effectively transmits all logs located at `/var/log/**/*log`, from the charm unit to Loki. Additionally, it collects logs concerning crashed runners with accessible but unshut LXD virtual machines.
+The `grafana-agent` effectively transmits all logs located at `/var/log/**/*log`, from the charm unit to Loki. Additionally, it collects logs concerning crashed runners with accessible but unshut LXD virtual machines.
diff --git a/docs/tutorial/managing-resource-usage.md b/docs/tutorial/managing-resource-usage.md
@@ -24,4 +24,4 @@ The recommended combined resource usage is:
 
 ## Juju machine constraints
 
-During [deployment of the charm](https://juju.is/docs/juju/juju-deploy), constraints can be used to specify the juju machine resource requirements. For example, `juju deploy github-runner --constraints="cores=4 mem=16G disk=20G"`.
+During [deployment of the charm](https://juju.is/docs/juju/juju-deploy), constraints can be used to specify the juju machine resource requirements. For example, `juju deploy github-runner --constraints="cores=4 mem=16G disk=20G"`.
diff --git a/docs/tutorial/quick-start.md b/docs/tutorial/quick-start.md
@@ -87,4 +87,4 @@ The charm and the self-hosted runners can be removed with the following command:
 
 ```shell
 juju remove-application github-runner
-```
+```