diff --git a/docs/how-to/contribute.md b/docs/how-to/contribute.md index 1fff552..e5bb593 100644 --- a/docs/how-to/contribute.md +++ b/docs/how-to/contribute.md @@ -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. +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 diff --git a/docs/index.md b/docs/index.md index 5323026..4928ee9 100644 --- a/docs/index.md +++ b/docs/index.md @@ -19,5 +19,15 @@ 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 | -# Navigation - +# Contents + +1. [Explanation](explanation) + 1. [Charm architecture](explanation/charm-architecture.md) +1. [How To](how-to) + 1. [How to contribute](how-to/contribute.md) +1. [Reference](reference) + 1. [Actions](reference/actions.md) + 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 diff --git a/docs/reference/actions.md b/docs/reference/actions.md index a56da4b..a852207 100644 --- a/docs/reference/actions.md +++ b/docs/reference/actions.md @@ -1,3 +1,3 @@ # Actions -See [Actions](https://charmhub.io/jenkins-agent-k8s/actions). +See [Actions](https://charmhub.io/jenkins-agent-k8s/actions). \ No newline at end of file diff --git a/docs/reference/configurations.md b/docs/reference/configurations.md index 8165aa6..a3e7ae4 100644 --- a/docs/reference/configurations.md +++ b/docs/reference/configurations.md @@ -1,3 +1,3 @@ # Configurations -See [Configure](https://charmhub.io/jenkins-agent-k8s/configure). +See [Configure](https://charmhub.io/jenkins-agent-k8s/configure). \ No newline at end of file diff --git a/docs/reference/integrations.md b/docs/reference/integrations.md index 37f7143..27c079d 100644 --- a/docs/reference/integrations.md +++ b/docs/reference/integrations.md @@ -7,4 +7,4 @@ _Supported charms_: [jenkins](https://charmhub.io/jenkins) Agent integration is a required relation for the Jenkins agent charm to supply the job execution output to Jenkins. -Example agent integrate command: `juju integrate jenkins jenkins-agent-k8s` +Example agent integrate command: `juju integrate jenkins jenkins-agent-k8s` \ No newline at end of file diff --git a/docs/tutorial/getting-started.md b/docs/tutorial/getting-started.md index 143b408..8443edc 100644 --- a/docs/tutorial/getting-started.md +++ b/docs/tutorial/getting-started.md @@ -59,4 +59,4 @@ jenkins-agent-k8s active 1 jenkins-agent-k8s stable 18 10. ``` -The deployment finishes when the status shows "Active". +The deployment finishes when the status shows "Active". \ No newline at end of file