modified: docs/how-to-guides/contribute.md,docs/index.md (#126)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: yhaliaw <[email protected]>

docs/how-to-guides/contribute.md → docs/how-to-guides/contributing.md

@@ -1,7 +1,6 @@
 # How to contribute
 
 ## Overview
-
 This document explains the processes and practices recommended for contributing enhancements to the GitHub Runner operator.
 
 * Generally, before developing enhancements to this charm, you should consider [opening an issue](https://github.com/canonical/github-runner-operator/issues) explaining your use case.
@@ -23,19 +22,21 @@ The code for this charm can be downloaded as follows:
 git clone https://github.com/canonical/github-runner-operator.git
 ```
 
-To run tests, run `tox` from within the charm code directory.
+Prior to working on the charm ensure juju is connected to an LXD cloud,  see the [upstream documentation](https://juju.is/docs/lxd-cloud) for details.
 
 To build and deploy a local version of the charm, simply run:
 
 ```
 charmcraft pack
-# Ensure you're connected to a juju k8s model
+# Ensure you're connected to a juju LXD model.
 # Configure the machine resource created by the model
-juju set-model-constraints mem=8G cores=2 root-disk=50G
+juju set-model-constraints mem=22G cores=2 root-disk=20G
 # Assuming you're on amd64
-juju deploy ./github-runner_ubuntu-22.04-amd64_ubuntu-20.04-amd64.charm
+juju deploy ./github-runner_ubuntu-22.04-amd64.charm
 ```
 
+To test the charm, unit test can be ran with `tox -e unit` and the integration test on juju 3.1 can be ran with `tox -e integration-juju3.1`.
+
 ## 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.

docs/index.md

@@ -1,11 +1,11 @@
-## Github-runner operator
-GitHub self-hosted runner offer a way to run GitHub action workloads on non-GitHub servers.
-
-For information on GitHub Actions, see [this page](https://docs.github.com/en/actions).
-
-For information on self-hosted runner, see [this page](https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners).
+# Github-runner operator
+A [Juju](https://juju.is/) [charm](https://juju.is/docs/olm/charmed-operators) deploying self-hosted GitHub runners.
+  
+Each unit of this charm will start a configurable number of LXD based containers and virtual machines to host them. Each runner performs only one
+job, after which it unregisters from GitHub to ensure that each job runs in a clean environment. The charm will periodically check the number of idle runners and spawn or destroy them as
+necessary to maintain the configured number of runners. Both the reconciliation interval and the number of runners to maintain are configurable.
 
 ## Contributing to this documentation
 Documentation is an important part of this project, and we take the same open-source approach to the documentation as the code. As such, we welcome community contributions, suggestions and constructive feedback on our documentation. Our documentation is hosted on the [Charmhub forum](https://discourse.charmhub.io/t/github-runner-documentation-overview/7817) to enable easy collaboration. Please use the "Help us improve this documentation" links on each documentation page to either directly change something you see that's wrong, ask a question, or make a suggestion about a potential change via the comments section.
 
-If there's a particular area of documentation that you'd like to see that's missing, please [file a bug](https://github.com/canonical/github-runner-operator/issues).
+If there's a particular area of documentation that you'd like to see that's missing, please [file a bug](https://github.com/canonical/github-runner-operator/issues).