diff --git a/docs/canonicalk8s/index.md b/docs/canonicalk8s/index.md index afdf49e68..cac12daaf 100644 --- a/docs/canonicalk8s/index.md +++ b/docs/canonicalk8s/index.md @@ -101,8 +101,8 @@ and constructive feedback. [Code of Conduct]: https://ubuntu.com/community/ethos/code-of-conduct -[community]: snap/reference/community -[contribute]: snap/howto/contribute -[roadmap]: snap/reference/roadmap -[overview page]: snap/explanation/about -[architecture documentation]: snap/reference/architecture +[community]: src/snap/reference/community +[contribute]: src/snap/howto/contribute +[roadmap]: src/snap/reference/roadmap +[overview page]: src/snap/explanation/about +[architecture documentation]: src/snap/reference/architecture diff --git a/docs/canonicalk8s/unused-index.md b/docs/canonicalk8s/unused-index.md deleted file mode 100644 index a3f1f8571..000000000 --- a/docs/canonicalk8s/unused-index.md +++ /dev/null @@ -1,108 +0,0 @@ -# {{product}} documentation - -{{product}} is a performant, lightweight, secure and -opinionated distribution of **Kubernetes** which includes everything needed to -create and manage a scalable cluster suitable for all use cases. - -You can find out more about {{product}} on this [overview page] or -see a more detailed explanation in our [architecture documentation]. - -![Illustration depicting working on components and clouds][logo] - -```{toctree} -:hidden: -:titlesonly: -Home -``` - -```{toctree} -:hidden: -:titlesonly: -:maxdepth: 6 -:caption: Deploy from Snap package -Overview -src/snap/tutorial/index -src/snap/howto/index -src/snap/explanation/index -src/snap/reference/index -``` - -```{toctree} -:hidden: -:caption: Deploy with Juju -:titlesonly: -:glob: -Overview -src/charm/tutorial/index -src/charm/howto/index -src/charm/explanation/index -src/charm/reference/index -``` - -```{toctree} -:hidden: -:caption: Deploy with Cluster API (WIP) -:titlesonly: -:glob: -Overview -src/capi/tutorial/index -src/capi/howto/index -src/capi/explanation/index -src/capi/reference/index -``` - ---- - -````{grid} 1 1 2 2 - -```{grid-item-card} -:link: snap/ -### [Install K8s from a snap ›](snap/index) -^^^ -Our tutorials, How To guides and other pages will explain how to install, - configure and use the {{product}} 'k8s' snap. -``` - -```{grid-item-card} -:link: charm/ -### [Deploy K8s using Juju ›](charm/index) -^^^ -Our tutorials, How To guides and other pages will explain how to install, - configure and use the {{product}} 'k8s' charm. -``` - - -```{grid-item-card} -:link: capi/ -### [Deploy K8s using Cluster API ›](capi/index) -^^^ -Our tutorials, guides and explanation pages will explain how to install, - configure and use {{product}} through CAPI. -``` -```` - ---- - -## Project and community - -{{product}} is a member of the Ubuntu family. It's an open source -project which welcomes community involvement, contributions, suggestions, fixes -and constructive feedback. - -- Our [Code of Conduct] -- Our [community] -- How to [contribute] -- Our development [roadmap] - - - -[logo]: https://assets.ubuntu.com/v1/843c77b6-juju-at-a-glace.svg - - - -[Code of Conduct]: https://ubuntu.com/community/ethos/code-of-conduct -[community]: snap/reference/community -[contribute]: snap/howto/contribute -[roadmap]: snap/reference/roadmap -[overview page]: snap/explanation/about -[architecture documentation]: snap/reference/architecture diff --git a/docs/src/capi/explanation/security.md b/docs/src/capi/explanation/security.md index 6c1048a19..591943f36 100644 --- a/docs/src/capi/explanation/security.md +++ b/docs/src/capi/explanation/security.md @@ -1,2 +1,4 @@ +# Security + ```{include} /snap/explanation/security.md ``` diff --git a/docs/src/charm/explanation/index.md b/docs/src/charm/explanation/index.md index 58409c598..e73fa9827 100644 --- a/docs/src/charm/explanation/index.md +++ b/docs/src/charm/explanation/index.md @@ -39,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]: ../explanation/index.md diff --git a/docs/src/charm/explanation/security.md b/docs/src/charm/explanation/security.md index 6c1048a19..591943f36 100644 --- a/docs/src/charm/explanation/security.md +++ b/docs/src/charm/explanation/security.md @@ -1,2 +1,4 @@ +# Security + ```{include} /snap/explanation/security.md ``` diff --git a/docs/src/charm/reference/proxy.md b/docs/src/charm/reference/proxy.md index e4dfd0e16..34facb058 100644 --- a/docs/src/charm/reference/proxy.md +++ b/docs/src/charm/reference/proxy.md @@ -1,2 +1,4 @@ +# Proxies + ```{include} /snap/reference/proxy.md ``` \ No newline at end of file diff --git a/docs/src/old-index.md b/docs/src/old-index.md deleted file mode 100644 index 1635cc3f5..000000000 --- a/docs/src/old-index.md +++ /dev/null @@ -1,108 +0,0 @@ -# {{product}} documentation - -{{product}} is a performant, lightweight, secure and -opinionated distribution of **Kubernetes** which includes everything needed to -create and manage a scalable cluster suitable for all use cases. - -You can find out more about {{product}} on this [overview page] or -see a more detailed explanation in our [architecture documentation]. - -![Illustration depicting working on components and clouds][logo] - -```{toctree} -:hidden: -:titlesonly: -Home -``` - -```{toctree} -:hidden: -:titlesonly: -:maxdepth: 6 -:caption: Deploy from Snap package -Overview -snap/tutorial/index -snap/howto/index -snap/explanation/index -snap/reference/index -``` - -```{toctree} -:hidden: -:caption: Deploy with Juju -:titlesonly: -:glob: -Overview -charm/tutorial/index -charm/howto/index -charm/explanation/index -charm/reference/index -``` - -```{toctree} -:hidden: -:caption: Deploy with Cluster API (WIP) -:titlesonly: -:glob: -Overview -capi/tutorial/index -capi/howto/index -capi/explanation/index -capi/reference/index -``` - ---- - -````{grid} 1 1 2 2 - -```{grid-item-card} -:link: snap/ -### [Install K8s from a snap ›](snap/index) -^^^ -Our tutorials, How To guides and other pages will explain how to install, - configure and use the {{product}} 'k8s' snap. -``` - -```{grid-item-card} -:link: charm/ -### [Deploy K8s using Juju ›](charm/index) -^^^ -Our tutorials, How To guides and other pages will explain how to install, - configure and use the {{product}} 'k8s' charm. -``` - - -```{grid-item-card} -:link: capi/ -### [Deploy K8s using Cluster API ›](capi/index) -^^^ -Our tutorials, guides and explanation pages will explain how to install, - configure and use {{product}} through CAPI. -``` -```` - ---- - -## Project and community - -{{product}} is a member of the Ubuntu family. It's an open source -project which welcomes community involvement, contributions, suggestions, fixes -and constructive feedback. - -- Our [Code of Conduct] -- Our [community] -- How to [contribute] -- Our development [roadmap] - - - -[logo]: https://assets.ubuntu.com/v1/843c77b6-juju-at-a-glace.svg - - - -[Code of Conduct]: https://ubuntu.com/community/ethos/code-of-conduct -[community]: snap/reference/community -[contribute]: snap/howto/contribute -[roadmap]: snap/reference/roadmap -[overview page]: snap/explanation/about -[architecture documentation]: snap/reference/architecture