Skip to content

Commit

Permalink
Update home page (#951)
Browse files Browse the repository at this point in the history
Received guidance on best practices for home pages from the docs team and applied them to this PR
  • Loading branch information
nhennigan authored Jan 16, 2025
1 parent 29c49e4 commit cecf6eb
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 28 deletions.
63 changes: 39 additions & 24 deletions docs/canonicalk8s/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,48 @@
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].
{{product}} builds upon upstream Kubernetes by providing all the extra services
such as a container runtime, a CNI, DNS services, an ingress gateway and more
that are necessary to have a fully functioning cluster all in one convenient
location - a snap!

Staying up-to-date with upstream Kubernetes security
patches and updates with {{product}} is a seamless experience, freeing up time
for application
development and innovation without having to worry about the infrastructure.

Whether you are deploying a small cluster to get accustomed to Kubernetes or a
huge enterprise level deployment across the globe, {{product}} can cater to
your needs. If would like to jump straight in, head to the
[snap getting started tutorial!](src/snap/tutorial/getting-started.md)

![Illustration depicting working on components and clouds][logo]

---

## In this documentation
<!-- markdownlint-disable -->
{{product}} can be deployed as a standalone snap, as a charm as part of a
Juju cluster or with Cluster API. Find out more about which {{product}}
installation method is best for your
project's needs with
**[choosing a {{product}} installation method.](src/snap/explanation/installation-methods.md)**
<!-- markdownlint-restore -->

```{toctree}
:hidden:
:titlesonly:
Home <self>
Canonical Kubernetes documentation <self>
```

---

```{toctree}
:hidden:
:titlesonly:
:maxdepth: 6
src/about.md
Choose an installation method <src/snap/explanation/installation-methods.md>
Deploy from Snap package <src/snap/index.md>
Deploy with Juju <src/charm/index.md>
Deploy with Cluster API <src/capi/index.md>
Expand All @@ -30,40 +54,33 @@ Release notes <src/releases.md>
```

````{grid} 1 1 2 2
````{grid} 1 1 1 1
```{grid-item-card}
:link: src/snap/
### [Install K8s from a snap ›](src/snap/index)
^^^
Our tutorials, How To guides and other pages will explain how to install,
configure and use the {{product}} 'k8s' snap. This is a great option if you are new to Kubernetes.
### [Install with a snap ›](src/snap/index)
Our tutorials, how-to guides and other pages will explain how to install,
configure and use the {{product}} 'k8s' snap. If you are new to Kubernetes, start here.
```
```{grid-item-card}
:link: src/charm/
### [Deploy K8s using Juju ›](src/charm/index)
^^^
Our tutorials, How To guides and other pages will explain how to install,
### [Deploy with Juju ›](src/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: src/capi/
### [Deploy K8s using Cluster API ›](src/capi/index)
^^^
Our tutorials, guides and explanation pages will explain how to install,
### [Deploy with Cluster API ›](src/capi/index)
Our tutorials, how-to guides and other pages will explain how to install,
configure and use {{product}} through CAPI.
```
```{grid-item-card}
:link: about
### [Overview of {{product}} ›](about)
^^^
Find out more about {{product}}, what services are included and get the
answers to some common questions.
```
````

---
Expand All @@ -89,5 +106,3 @@ and constructive feedback.
[community]: src/snap/reference/community
[contribute]: src/snap/howto/contribute
[releases]: src/snap/reference/releases
[overview page]: about
[architecture documentation]: src/snap/reference/architecture
10 changes: 6 additions & 4 deletions docs/src/snap/explanation/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ maintain and easy to upgrade.

## What else comes with it?

In addition to the upstream Kubernetes services,
In addition to the upstream Kubernetes services,
{{product}} also includes:

- a DNS service for the node
Expand All @@ -32,9 +32,10 @@ In addition to the upstream Kubernetes services,
The {{product}} snap can be installed on a Linux OS, wherever it may be: run it
in several local containers or VMs for example, or use it on public/private
cloud instances. For deploying with [Juju], a machine [charm] to deploy the
snap is also available.
For deployment using Cluster API, a Bootstrap and
Control-plane provider have also been created.
snap is also available.
For deployment using Cluster API, a bootstrap and
control-plane provider have also been created. See the [choosing an installation
method] page to see which method best suits your project's needs.

## Can I use it to make a cluster?

Expand Down Expand Up @@ -66,3 +67,4 @@ visit the [Ubuntu support] page.
[Community page]: community.md
[Ubuntu Pro]: https://ubuntu.com/pro
[Ubuntu support]: https://ubuntu.com/support
[choosing an installation method]: /src/snap/explanation/installation-methods.md

0 comments on commit cecf6eb

Please sign in to comment.