[discourse-gatekeeper] Migrate charm docs (#44)

* new: docs/index.md,docs/contributing-hacking.md,docs/relations.md * modified: docs/index.md // new: docs/tutorial/getting-started.md,docs/reference/actions.md,docs/reference/configurations.md,docs/how-to/contribute.md,docs/reference/integrations.md * remove old docs * modified: docs/tutorial/getting-started.md,docs/reference/configurations.md,docs/reference/actions.md,docs/reference/integrations.md,docs/how-to/contribute.md,docs/index.md --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Arturo Seijas <[email protected]>
canonical · Feb 1, 2024 · 9a71adf · 9a71adf
1 parent 9fccb5d
commit 9a71adf
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 7 deletions.
diff --git 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.
diff --git 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)</br>  Get started - a hands-on introduction to using the Charmed Indico operator for new users </br> |  [How-to guides](https://charmhub.io/jenkins-agent-k8s/docs/how-to-contribute) </br> Step-by-step guides covering key operations and common tasks |
 | [Reference](https://charmhub.io/jenkins-agent-k8s/docs/reference-actions) </br> Technical information - specifications, APIs, architecture | [Explanation](https://charmhub.io/jenkins-agent-k8s/docs/explanation-charm-architecture) </br> 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)
diff --git 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).
diff --git 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).
diff --git 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`
diff --git 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".