Docs cleanup (#405)

* move cos-lite * fix cos link * fix charm architecture doc * small linting fixes
canonical · May 6, 2024 · 9250ccc · 9250ccc
1 parent 4adc084
commit 9250ccc
Show file tree

Hide file tree

Showing 10 changed files with 16 additions and 11 deletions.
diff --git a/docs/src/charm/explanation/about.md b/docs/src/charm/explanation/about.md
@@ -2,4 +2,4 @@
 
 ```{include} ../../snap/explanation/about.md
 :start-after: '# What is Canonical Kubernetes?'
-```
+```
diff --git a/docs/src/charm/explanation/channels.md b/docs/src/charm/explanation/channels.md
@@ -1,2 +1,2 @@
 ```{include} ../../snap/explanation/channels.md
-```
+```
diff --git a/docs/src/charm/explanation/index.md b/docs/src/charm/explanation/index.md
@@ -16,9 +16,8 @@ channels
 security
 ```
 
-For topics specifically relating to the snap version of Canonical Kubernetes, 
-please see the [explanation topic]. 
-
+For topics specifically relating to the snap version of Canonical Kubernetes,
+please see the [explanation topic].
 
 ---
 
@@ -40,4 +39,4 @@ details or information such as the command reference or release notes.
 [Tutorials section]: ../tutorial/index
 [How-to guides]:     ../howto/index
 [Reference section]: ../reference/index
-[explanation topic]: /snap/explanation/index.md
+[explanation topic]: /snap/explanation/index.md
diff --git a/docs/src/charm/explanation/security.md b/docs/src/charm/explanation/security.md
@@ -1,2 +1,2 @@
 ```{include} /snap/explanation/security.md
-```
+```
diff --git a/docs/src/snap/howto/cos-lite.md → docs/src/charm/howto/cos-lite.md b/docs/src/snap/howto/cos-lite.md → docs/src/charm/howto/cos-lite.md
diff --git a/docs/src/charm/howto/etcd.md b/docs/src/charm/howto/etcd.md
@@ -106,6 +106,7 @@ datastore.
 to verify that all components are functioning correctly. Use the `juju status`
 command to inspect the current status of your cluster.
 
+<!-- markdownlint-disable -->
 ```
 Model       Controller  Cloud/Region   Version  SLA          Timestamp
 my-cluster  canonicaws  aws/us-east-1  3.4.2    unsupported  16:02:18-05:00
@@ -133,9 +134,10 @@ Machine  State    Address         Inst id              Base          AZ
 5        started  3.238.230.3     i-0773583e7a5fbf07e  [email protected]  us-east-1f  running
 6        started  34.229.202.243  i-0f03b9833a338380c  [email protected]  us-east-1b  running
 ```
+<!-- markdownlint-restore -->
 
 <!-- LINKS -->
 
-[easyrsa-charm]: https://charmhub.io/easyrsa 
+[easyrsa-charm]: https://charmhub.io/easyrsa
 [vault-charm]: https://charmhub.io/vault
 [Juju setup]: https://juju.is/docs/juju/tutorial
diff --git a/docs/src/charm/howto/index.md b/docs/src/charm/howto/index.md
@@ -17,6 +17,7 @@ Overview <self>
 charm
 etcd
 proxy
+cos-lite
 contribute
 
 ```

diff --git a/docs/src/charm/reference/architecture.md b/docs/src/charm/reference/architecture.md
@@ -1 +1,5 @@
-# K8s charm arcitecture
+# K8s charm arcitecture
+
+```{include} /snap/reference/architecture.md
+   :start-after: '## Canonical K8s charms'
+```
diff --git a/docs/src/snap/howto/index.md b/docs/src/snap/howto/index.md
@@ -18,7 +18,6 @@ install/index
 networking/index
 storage
 external-datastore
-cos-lite
 proxy
 contribute
 support

diff --git a/docs/src/snap/reference/releases.md b/docs/src/snap/reference/releases.md
@@ -36,4 +36,4 @@ Follow along with the [tutorial] to get started!
 [nodes]: /snap/tutorial/add-remove-nodes
 [COS Lite]: https://charmhub.io/cos-lite
 [networking]: /snap/howto/networking/index
-[observability documentation]: /snap/howto/cos-lite
+[observability documentation]: /charm/howto/cos-lite