Skip to content

doc: update MicroCloud docs URLs #1466

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
roosterfish merged 1 commit into from
Jul 17, 2026
Merged

doc: update MicroCloud docs URLs #1466

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,4 +104,4 @@ In addition to the sign-off requirement, contributors must also cryptographicall

## More information

For more information, see [How to contribute to MicroCloud](https://documentation.ubuntu.com/microcloud/latest/microcloud/how-to/contribute/) in the documentation.
For more information, see [How to contribute to MicroCloud](https://canonical.com/microcloud/docs/latest/how-to/contribute/) in the documentation.
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ MicroCloud is designed for small-scale private clouds and hybrid cloud extension

MicroCloud can be deployed on machines running Ubuntu 22.04 or newer. A MicroCloud cluster can consist of a single cluster member for a testing deployment, and requires a minimum of 3 cluster members for a production deployment.

See: [Pre-deployment requirements](https://documentation.ubuntu.com/microcloud/latest/microcloud/how-to/install/#pre-deployment-requirements) in the MicroCloud documentation for a full list of requirements.
See: [Pre-deployment requirements](https://canonical.com/microcloud/docs/latest/how-to/install/#pre-deployment-requirements) in the MicroCloud documentation for a full list of requirements.


## **How to get started**
Expand All @@ -46,13 +46,13 @@ microcloud join

Following the CLI prompts, a working MicroCloud will be ready within minutes.

The MicroCloud snap drives three other snaps ([LXD](https://documentation.ubuntu.com/microcloud/latest/lxd/), [MicroCeph](https://documentation.ubuntu.com/microcloud/latest/microceph/), and [MicroOVN](https://documentation.ubuntu.com/microcloud/latest/microovn/)), enabling automated deployment of a highly available LXD cluster for compute, with Ceph as the storage driver and OVN as the managed network.
The MicroCloud snap drives three other snaps ([LXD](https://canonical.com/microcloud/docs/latest/lxd/), [MicroCeph](https://canonical.com/microcloud/docs/latest/microceph/), and [MicroOVN](https://canonical.com/microcloud/docs/latest/microovn/)), enabling automated deployment of a highly available LXD cluster for compute, with Ceph as the storage driver and OVN as the managed network.

During initialization, MicroCloud scrapes the other servers for details and then prompts you to add disks to Ceph and configure the networking setup.

At the end of this, you’ll have an OVN cluster, a Ceph cluster, and a LXD cluster. LXD itself will have been configured with both networking and storage suitable for use in a cluster.

For more information, see the MicroCloud documentation for [installation](https://documentation.ubuntu.com/microcloud/latest/microcloud/how-to/install/) and [initialization](https://documentation.ubuntu.com/microcloud/latest/microcloud/how-to/initialize/). You can also [follow a tutorial](https://documentation.ubuntu.com/microcloud/latest/microcloud/tutorial/get_started/) that demonstrates the basics of MicroCloud.
For more information, see the MicroCloud documentation for [installation](https://canonical.com/microcloud/docs/latest/how-to/install/) and [initialization](https://canonical.com/microcloud/docs/latest/how-to/initialize/). You can also [follow a tutorial](https://canonical.com/microcloud/docs/latest/tutorial/) that demonstrates the basics of MicroCloud.

## **What about networking?**

Expand All @@ -66,7 +66,7 @@ You can optionally add the following dedicated networks:

### **RESOURCES:**

- Documentation: https://documentation.ubuntu.com/microcloud/latest/microcloud/
- Documentation: <https://canonical.com/microcloud/docs/latest/>
- Find the package at the Snap Store:

[![Snapcraft logo](https://dashboard.snapcraft.io/site_media/appmedia/2018/04/Snapcraft-logo-bird.png)](https://snapcraft.io/microcloud)
Expand Down
4 changes: 2 additions & 2 deletions doc/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# MicroCloud documentation

We advise you to read the [published documentation](https://documentation.ubuntu.com/microcloud/latest/microcloud/) rather than reading the documentation through GitHub. The GitHub web interface provides a basic rendering of the documentation. However, important features are missing, such as includes and cross-references.
We advise you to read the [published documentation](https://canonical.com/microcloud/docs/latest/) rather than reading the documentation through GitHub. The GitHub web interface provides a basic rendering of the documentation. However, important features are missing, such as includes and cross-references.

Compelled to contribute to the documentation? Visit the [documentation contributor guidelines](https://documentation.ubuntu.com/microcloud/latest/microcloud/how-to/contribute//#contribute-to-the-documentation).
Compelled to contribute to the documentation? Visit the [documentation contributor guidelines](https://canonical.com/microcloud/docs/latest/how-to/contribute/#contribute-to-the-documentation).
2 changes: 1 addition & 1 deletion doc/how-to/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Install all required {ref}`snaps <reference-requirements-software-snaps>` on eac

```{admonition} Snap channels
:class: note
The snap channels shown below install the current {ref}`feature release <ref-releases-microcloud-feature>` of MicroCloud, along with the most recent compatible releases for its components. To install the {ref}`current LTS release <ref-releases-microcloud-lts>` of MicroCloud instead, refer to the [install guide for that version](https://documentation.ubuntu.com/microcloud/default/how-to/install/).
The snap channels shown below install the current {ref}`feature release <ref-releases-microcloud-feature>` of MicroCloud, along with the most recent compatible releases for its components. To install the {ref}`current LTS release <ref-releases-microcloud-lts>` of MicroCloud instead, refer to the [install guide for that version](https://canonical.com/microcloud/docs/default/how-to/install/).
```

```bash
Expand Down
2 changes: 1 addition & 1 deletion doc/how-to/support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Ask questions or engage in discussions in our [Discourse forum](https://discours

### Documentation

Access the [official documentation](https://documentation.ubuntu.com/microcloud/latest/).
Access the [official documentation](https://canonical.com/microcloud/docs/latest/).

### Bug reports and feature requests

Expand Down
Loading