diff --git a/docs/how-to/contribute.md b/docs/how-to/contribute.md index e5bb593..e514d16 100644 --- a/docs/how-to/contribute.md +++ b/docs/how-to/contribute.md @@ -35,7 +35,7 @@ source .tox/unit/bin/activate ### Testing -Note that the [Jenkins agent k8s](jenkins_agent_k8s_rock/rockcraft.yaml) needs to be built and pushed to microk8s for the tests to run. It should be tagged as `localhost:32000/jenkins-agent-k8s:latest` so that Kubernetes knows how to pull them from the microk8s repository. Note that the microk8s registry needs to be enabled using `microk8s enable registry`. More details regarding the OCI images below. The following commands can then be used to run the tests: +Note that the [Jenkins agent k8s](jenkins_agent_k8s_rock/rockcraft.yaml) needs to be built and pushed to MicroK8s for the tests to run. It should be tagged as `localhost:32000/jenkins-agent-k8s:latest` so that Kubernetes knows how to pull them from the MicroK8s repository. Note that the MicroK8s registry needs to be enabled using `microk8s enable registry`. More details regarding the OCI images below. The following commands can then be used to run the tests: * `tox`: Runs all of the basic checks (`lint`, `unit`, `static`, and `coverage-report`). * `tox -e fmt`: Runs formatting using `black` and `isort`. @@ -84,4 +84,4 @@ juju deploy ./jenkins-agent-k8s_ubuntu-22.04-amd64.charm \ ## Canonical Contributor Agreement -Canonical welcomes contributions to the Jenkins agent k8s operator. Please check out our [contributor agreement](https://ubuntu.com/legal/contributors) if you're interested in contributing to the solution. \ No newline at end of file +Canonical welcomes contributions to the Jenkins agent k8s 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/index.md b/docs/index.md index 4928ee9..82e8d8f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,12 +6,6 @@ As such, the charm makes it easy for those looking to take control of their own For DevOps or SRE teams this charm will make operating Jenkins agent simple and straightforward through Juju's clean interface. It will allow easy deployment into multiple environments for testing changes, and supports scaling out for enterprise deployments. -## 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/jenkins-agent-documentation-overview/3982) 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/jenkins-agent-k8s-operator/issues). - ## In this documentation | | | @@ -19,6 +13,13 @@ If there's a particular area of documentation that you'd like to see that's miss | [Tutorials](https://charmhub.io/jenkins-agent-k8s/docs/tutorial-getting-started)
Get started - a hands-on introduction to using the Charmed Indico operator for new users
| [How-to guides](https://charmhub.io/jenkins-agent-k8s/docs/how-to-contribute)
Step-by-step guides covering key operations and common tasks | | [Reference](https://charmhub.io/jenkins-agent-k8s/docs/reference-actions)
Technical information - specifications, APIs, architecture | [Explanation](https://charmhub.io/jenkins-agent-k8s/docs/explanation-charm-architecture)
Concepts - discussion and clarification of key topics | + +## 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/jenkins-agent-documentation-overview/3982) 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/jenkins-agent-k8s-operator/issues). + # Contents 1. [Explanation](explanation) @@ -30,4 +31,4 @@ If there's a particular area of documentation that you'd like to see that's miss 1. [Configurations](reference/configurations.md) 1. [Integrations](reference/integrations.md) 1. [Tutorial](tutorial) - 1. [Quick guide](tutorial/getting-started.md) \ No newline at end of file + 1. [Quick guide](tutorial/getting-started.md)