diff --git a/doc/.readthedocs.yaml b/doc/.readthedocs.yaml index 4e8f7690f..3df760f20 100644 --- a/doc/.readthedocs.yaml +++ b/doc/.readthedocs.yaml @@ -13,14 +13,14 @@ build: python: "3.12" commands: - git fetch --unshallow || true - - cd doc && make integrate - - cd doc/integration/lxd/ && go build -ldflags "-s -w" -o trimpath -o lxc.bin ./lxc + - cd doc && make GOTOOLCHAIN=auto integrate + - cd doc/integration/lxd/ && GOTOOLCHAIN=auto go build -ldflags "-s -w" -o trimpath -o lxc.bin ./lxc # Pretend that woke is installed - we don't need it for building # (workaround until https://github.com/canonical/microovn/pull/168 is merged # and https://github.com/canonical/microceph/pull/400 is restored) - ln -s /bin/true doc/integration/microovn/docs/woke - ln -s /bin/true doc/integration/microceph/docs/woke - - make doc-html-rtd PATH=$PATH:. + - make GOTOOLCHAIN=auto doc-html-rtd PATH=$PATH:. # Build documentation in the docs/ directory with Sphinx sphinx: diff --git a/doc/custom_conf.py b/doc/custom_conf.py index 3b43a9244..8d6307bf2 100644 --- a/doc/custom_conf.py +++ b/doc/custom_conf.py @@ -165,7 +165,7 @@ # These links may fail from time to time 'https://ceph.io', # Cloudflare protection on SourceForge domains often block linkcheck - r"https://.*\.sourceforge\.net/.*", + r"https://.*\.sourceforge\.(net|io)/.*", ] # Pages on which to ignore anchors diff --git a/doc/tutorial/multi-member.md b/doc/tutorial/multi-member.md index 4e95da16c..9a7442703 100644 --- a/doc/tutorial/multi-member.md +++ b/doc/tutorial/multi-member.md @@ -4,7 +4,7 @@ This tutorial guides you through installing and initializing MicroCloud in a confined environment, including storage and networking. You'll then start some instances to see what you can do with MicroCloud. This tutorial uses LXD virtual machines (VMs) for the MicroCloud cluster members, so you don't need any extra hardware to follow it. ```{tip} - Only use physical machines in a production environment. Use VMs as cluster members only in testing or development environments, such as this tutorial. For this, nested virtualization must be enabled on your host machine. See the [Ubuntu Server documentation on how to check if nested virtualization is enabled](https://documentation.ubuntu.com/server/how-to/virtualisation/enable-nested-virtualisation/#check-if-nested-virtualisation-is-enabled). + Only use physical machines in a production environment. Use VMs as cluster members only in testing or development environments, such as this tutorial. For this, nested virtualization must be enabled on your host machine. See the [Ubuntu Server documentation on how to check if nested virtualization is enabled](https://documentation.ubuntu.com/server/how-to/virtualisation/enable-nested-virtualisation). We also limit each machine in this tutorial to 2 GiB of RAM, which is less than the recommended hardware requirements. In the context of this tutorial, this amount of RAM is sufficient. However, in a production environment, make sure to use machines that fulfill the {ref}`reference-requirements-hardware`. ```