From f038e81a3aeba51ac9f8a15debf18bad74a3be17 Mon Sep 17 00:00:00 2001 From: davidekete Date: Tue, 24 Sep 2024 16:17:47 +0100 Subject: [PATCH 01/11] =?UTF-8?q?docs:=20Fix=20docs=20directory=20structur?= =?UTF-8?q?e=20to=20reflect=20Di=C3=A1taxis?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .gitignore | 1 + doc/{ => explanation}/explanation.md | 0 doc/{ => explanation}/generator.md | 0 doc/{ => explanation}/nm-all.md | 0 doc/{ => explanation}/security.md | 0 doc/{ => explanation}/structure-id.md | 0 doc/{ => howto}/contribute-docs.md | 0 doc/{ => howto}/creating-link-aggregation.md | 0 doc/{ => howto}/dbus-config.md | 0 doc/{ => howto}/examples.md | 0 doc/{ => howto}/howto.md | 0 .../matching-interface-by-mac-address.md | 0 .../multi-nic-vm-host-with-bonds-and-vlans.md | 0 doc/{ => howto}/netplan-everywhere.md | 0 .../single-nic-vm-host-with-vlans.md | 0 doc/{ => howto}/single-nic-vm-host.md | 0 doc/{ => howto}/using-static-ip-addresses.md | 0 doc/index.md | 31 +++++++++---------- doc/{ => reference}/apidoc/inc-netdef.md | 0 doc/{ => reference}/apidoc/inc-parse-nm.md | 0 doc/{ => reference}/apidoc/inc-parse.md | 0 doc/{ => reference}/apidoc/inc-state.md | 0 doc/{ => reference}/apidoc/inc-types.md | 0 doc/{ => reference}/apidoc/inc-util.md | 0 doc/{ => reference}/apidoc/index.md | 0 doc/{ => reference}/cli.md | 0 doc/{ => reference}/netplan-apply.md | 0 doc/{ => reference}/netplan-dbus.md | 0 doc/{ => reference}/netplan-generate.md | 0 doc/{ => reference}/netplan-get.md | 0 doc/{ => reference}/netplan-info.md | 0 doc/{ => reference}/netplan-ip.md | 0 doc/{ => reference}/netplan-rebind.md | 0 doc/{ => reference}/netplan-set.md | 0 doc/{ => reference}/netplan-status.md | 0 doc/{ => reference}/netplan-try.md | 0 doc/{ => reference}/netplan-yaml.md | 0 doc/{ => reference}/reference.md | 0 doc/{ => tutorial}/netplan-tutorial.md | 0 doc/{ => tutorial}/tutorial.md | 0 40 files changed, 16 insertions(+), 16 deletions(-) rename doc/{ => explanation}/explanation.md (100%) rename doc/{ => explanation}/generator.md (100%) rename doc/{ => explanation}/nm-all.md (100%) rename doc/{ => explanation}/security.md (100%) rename doc/{ => explanation}/structure-id.md (100%) rename doc/{ => howto}/contribute-docs.md (100%) rename doc/{ => howto}/creating-link-aggregation.md (100%) rename doc/{ => howto}/dbus-config.md (100%) rename doc/{ => howto}/examples.md (100%) rename doc/{ => howto}/howto.md (100%) rename doc/{ => howto}/matching-interface-by-mac-address.md (100%) rename doc/{ => howto}/multi-nic-vm-host-with-bonds-and-vlans.md (100%) rename doc/{ => howto}/netplan-everywhere.md (100%) rename doc/{ => howto}/single-nic-vm-host-with-vlans.md (100%) rename doc/{ => howto}/single-nic-vm-host.md (100%) rename doc/{ => howto}/using-static-ip-addresses.md (100%) rename doc/{ => reference}/apidoc/inc-netdef.md (100%) rename doc/{ => reference}/apidoc/inc-parse-nm.md (100%) rename doc/{ => reference}/apidoc/inc-parse.md (100%) rename doc/{ => reference}/apidoc/inc-state.md (100%) rename doc/{ => reference}/apidoc/inc-types.md (100%) rename doc/{ => reference}/apidoc/inc-util.md (100%) rename doc/{ => reference}/apidoc/index.md (100%) rename doc/{ => reference}/cli.md (100%) rename doc/{ => reference}/netplan-apply.md (100%) rename doc/{ => reference}/netplan-dbus.md (100%) rename doc/{ => reference}/netplan-generate.md (100%) rename doc/{ => reference}/netplan-get.md (100%) rename doc/{ => reference}/netplan-info.md (100%) rename doc/{ => reference}/netplan-ip.md (100%) rename doc/{ => reference}/netplan-rebind.md (100%) rename doc/{ => reference}/netplan-set.md (100%) rename doc/{ => reference}/netplan-status.md (100%) rename doc/{ => reference}/netplan-try.md (100%) rename doc/{ => reference}/netplan-yaml.md (100%) rename doc/{ => reference}/reference.md (100%) rename doc/{ => tutorial}/netplan-tutorial.md (100%) rename doc/{ => tutorial}/tutorial.md (100%) diff --git a/.gitignore b/.gitignore index 739bc992b..fb082f4e4 100644 --- a/.gitignore +++ b/.gitignore @@ -10,3 +10,4 @@ __pycache__ src/_features.h netplan_cli/_features.py dbus/io.netplan.Netplan.service +.DS_Store diff --git a/doc/explanation.md b/doc/explanation/explanation.md similarity index 100% rename from doc/explanation.md rename to doc/explanation/explanation.md diff --git a/doc/generator.md b/doc/explanation/generator.md similarity index 100% rename from doc/generator.md rename to doc/explanation/generator.md diff --git a/doc/nm-all.md b/doc/explanation/nm-all.md similarity index 100% rename from doc/nm-all.md rename to doc/explanation/nm-all.md diff --git a/doc/security.md b/doc/explanation/security.md similarity index 100% rename from doc/security.md rename to doc/explanation/security.md diff --git a/doc/structure-id.md b/doc/explanation/structure-id.md similarity index 100% rename from doc/structure-id.md rename to doc/explanation/structure-id.md diff --git a/doc/contribute-docs.md b/doc/howto/contribute-docs.md similarity index 100% rename from doc/contribute-docs.md rename to doc/howto/contribute-docs.md diff --git a/doc/creating-link-aggregation.md b/doc/howto/creating-link-aggregation.md similarity index 100% rename from doc/creating-link-aggregation.md rename to doc/howto/creating-link-aggregation.md diff --git a/doc/dbus-config.md b/doc/howto/dbus-config.md similarity index 100% rename from doc/dbus-config.md rename to doc/howto/dbus-config.md diff --git a/doc/examples.md b/doc/howto/examples.md similarity index 100% rename from doc/examples.md rename to doc/howto/examples.md diff --git a/doc/howto.md b/doc/howto/howto.md similarity index 100% rename from doc/howto.md rename to doc/howto/howto.md diff --git a/doc/matching-interface-by-mac-address.md b/doc/howto/matching-interface-by-mac-address.md similarity index 100% rename from doc/matching-interface-by-mac-address.md rename to doc/howto/matching-interface-by-mac-address.md diff --git a/doc/multi-nic-vm-host-with-bonds-and-vlans.md b/doc/howto/multi-nic-vm-host-with-bonds-and-vlans.md similarity index 100% rename from doc/multi-nic-vm-host-with-bonds-and-vlans.md rename to doc/howto/multi-nic-vm-host-with-bonds-and-vlans.md diff --git a/doc/netplan-everywhere.md b/doc/howto/netplan-everywhere.md similarity index 100% rename from doc/netplan-everywhere.md rename to doc/howto/netplan-everywhere.md diff --git a/doc/single-nic-vm-host-with-vlans.md b/doc/howto/single-nic-vm-host-with-vlans.md similarity index 100% rename from doc/single-nic-vm-host-with-vlans.md rename to doc/howto/single-nic-vm-host-with-vlans.md diff --git a/doc/single-nic-vm-host.md b/doc/howto/single-nic-vm-host.md similarity index 100% rename from doc/single-nic-vm-host.md rename to doc/howto/single-nic-vm-host.md diff --git a/doc/using-static-ip-addresses.md b/doc/howto/using-static-ip-addresses.md similarity index 100% rename from doc/using-static-ip-addresses.md rename to doc/howto/using-static-ip-addresses.md diff --git a/doc/index.md b/doc/index.md index d65763ad8..41eec6681 100644 --- a/doc/index.md +++ b/doc/index.md @@ -1,14 +1,13 @@ # Netplan documentation ```{toctree} ---- -maxdepth: 2 -hidden: true ---- -tutorial -howto -reference -explanation +:maxdepth: 2 +:hidden: true + +tutorial/tutorial +howto/howto +reference/reference +explanation/explanation ``` **Netplan** is a network configuration abstraction renderer. @@ -27,14 +26,14 @@ systemd-networkd. ::::{grid} 1 1 2 2 -:::{grid-item-card} **[Tutorial](/netplan-tutorial)** -:link: /netplan-tutorial +:::{grid-item-card} **[Tutorial](tutorial/netplan-tutorial)** +:link: tutorial/netplan-tutorial :link-type: doc **Get started** - hands-on introduction to Netplan for new users ::: -:::{grid-item-card} **[How-to guides](/examples)** -:link: /examples +:::{grid-item-card} **[How-to guides](howto/examples)** +:link: howto/examples :link-type: doc **Step-by-step guides** covering key operations and common tasks @@ -44,14 +43,14 @@ systemd-networkd. ::::{grid} 1 1 2 2 :reverse: -:::{grid-item-card} **[Reference](/reference)** -:link: /reference +:::{grid-item-card} **[Reference](reference/reference)** +:link: reference/reference :link-type: doc **Technical information** - specifications, APIs, architecture ::: -:::{grid-item-card} **[Explanation](/explanation)** -:link: /explanation +:::{grid-item-card} **[Explanation](explanation/explanation)** +:link: explanation/explanation :link-type: doc **Discussion and clarification** of key topics diff --git a/doc/apidoc/inc-netdef.md b/doc/reference/apidoc/inc-netdef.md similarity index 100% rename from doc/apidoc/inc-netdef.md rename to doc/reference/apidoc/inc-netdef.md diff --git a/doc/apidoc/inc-parse-nm.md b/doc/reference/apidoc/inc-parse-nm.md similarity index 100% rename from doc/apidoc/inc-parse-nm.md rename to doc/reference/apidoc/inc-parse-nm.md diff --git a/doc/apidoc/inc-parse.md b/doc/reference/apidoc/inc-parse.md similarity index 100% rename from doc/apidoc/inc-parse.md rename to doc/reference/apidoc/inc-parse.md diff --git a/doc/apidoc/inc-state.md b/doc/reference/apidoc/inc-state.md similarity index 100% rename from doc/apidoc/inc-state.md rename to doc/reference/apidoc/inc-state.md diff --git a/doc/apidoc/inc-types.md b/doc/reference/apidoc/inc-types.md similarity index 100% rename from doc/apidoc/inc-types.md rename to doc/reference/apidoc/inc-types.md diff --git a/doc/apidoc/inc-util.md b/doc/reference/apidoc/inc-util.md similarity index 100% rename from doc/apidoc/inc-util.md rename to doc/reference/apidoc/inc-util.md diff --git a/doc/apidoc/index.md b/doc/reference/apidoc/index.md similarity index 100% rename from doc/apidoc/index.md rename to doc/reference/apidoc/index.md diff --git a/doc/cli.md b/doc/reference/cli.md similarity index 100% rename from doc/cli.md rename to doc/reference/cli.md diff --git a/doc/netplan-apply.md b/doc/reference/netplan-apply.md similarity index 100% rename from doc/netplan-apply.md rename to doc/reference/netplan-apply.md diff --git a/doc/netplan-dbus.md b/doc/reference/netplan-dbus.md similarity index 100% rename from doc/netplan-dbus.md rename to doc/reference/netplan-dbus.md diff --git a/doc/netplan-generate.md b/doc/reference/netplan-generate.md similarity index 100% rename from doc/netplan-generate.md rename to doc/reference/netplan-generate.md diff --git a/doc/netplan-get.md b/doc/reference/netplan-get.md similarity index 100% rename from doc/netplan-get.md rename to doc/reference/netplan-get.md diff --git a/doc/netplan-info.md b/doc/reference/netplan-info.md similarity index 100% rename from doc/netplan-info.md rename to doc/reference/netplan-info.md diff --git a/doc/netplan-ip.md b/doc/reference/netplan-ip.md similarity index 100% rename from doc/netplan-ip.md rename to doc/reference/netplan-ip.md diff --git a/doc/netplan-rebind.md b/doc/reference/netplan-rebind.md similarity index 100% rename from doc/netplan-rebind.md rename to doc/reference/netplan-rebind.md diff --git a/doc/netplan-set.md b/doc/reference/netplan-set.md similarity index 100% rename from doc/netplan-set.md rename to doc/reference/netplan-set.md diff --git a/doc/netplan-status.md b/doc/reference/netplan-status.md similarity index 100% rename from doc/netplan-status.md rename to doc/reference/netplan-status.md diff --git a/doc/netplan-try.md b/doc/reference/netplan-try.md similarity index 100% rename from doc/netplan-try.md rename to doc/reference/netplan-try.md diff --git a/doc/netplan-yaml.md b/doc/reference/netplan-yaml.md similarity index 100% rename from doc/netplan-yaml.md rename to doc/reference/netplan-yaml.md diff --git a/doc/reference.md b/doc/reference/reference.md similarity index 100% rename from doc/reference.md rename to doc/reference/reference.md diff --git a/doc/netplan-tutorial.md b/doc/tutorial/netplan-tutorial.md similarity index 100% rename from doc/netplan-tutorial.md rename to doc/tutorial/netplan-tutorial.md diff --git a/doc/tutorial.md b/doc/tutorial/tutorial.md similarity index 100% rename from doc/tutorial.md rename to doc/tutorial/tutorial.md From 196c0b017bddbae5520a4e71ed64ac5fd8836659 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Kr=C3=A1tk=C3=BD?= Date: Tue, 24 Sep 2024 19:26:40 +0200 Subject: [PATCH 02/11] Meson and docs-validation updates to reflect new docs dir structure. --- doc/meson.build | 6 +++--- tests/validate_docs.sh | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/meson.build b/doc/meson.build index a4fc17150..4b1c4728a 100644 --- a/doc/meson.build +++ b/doc/meson.build @@ -1,12 +1,12 @@ if pandoc.found() custom_target( - input: ['manpage-header.md', 'structure-id.md', 'netplan-yaml.md', 'manpage-footer.md'], + input: ['manpage-header.md', 'explanation/structure-id.md', 'reference/netplan-yaml.md', 'manpage-footer.md'], output: 'netplan.5', command: [pandoc, '-s', '-o', '@OUTPUT@', '--from=markdown-smart', '@INPUT@'], install: true, install_dir: join_paths(get_option('mandir'), 'man5')) custom_target( - input: 'netplan-yaml.md', + input: 'reference/netplan-yaml.md', output: 'netplan.html', command: [pandoc, '-s', '--metadata', 'title="Netplan reference"', '--toc', '-o', '@OUTPUT@', '@INPUT@'], install: true, @@ -15,7 +15,7 @@ if pandoc.found() 'netplan-apply', 'netplan-dbus', 'netplan-generate', 'netplan-get', 'netplan-set', 'netplan-try', 'netplan-info', 'netplan-ip', 'netplan-status', 'netplan-rebind', ] - markdown = files(doc + '.md') + markdown = files('reference/' + doc + '.md') manpage = doc + '.8' custom_target( input: markdown, diff --git a/tests/validate_docs.sh b/tests/validate_docs.sh index 354dd5fe5..1fe478f69 100755 --- a/tests/validate_docs.sh +++ b/tests/validate_docs.sh @@ -17,12 +17,12 @@ fi for term in $(sed -n 's/[ ]\+{"\([a-z0-9-]\+\)", YAML_[A-Z]\+_NODE.*/\1/p' src/parse.c | sort | uniq); do # it can be documented in the following ways. # 1. "Properties for device type `blah:` - if egrep "## Properties for device type \`$term:\`" doc/netplan-yaml.md > /dev/null; then + if egrep "## Properties for device type \`$term:\`" doc/reference/netplan-yaml.md > /dev/null; then continue fi # 2. "[blah, ]**blah**[, **blah2**]: (scalar|bool|...) - if egrep "Alias: \*\*\`$term\`\*\*|\*\*\`$term\`\*\*.*\((scalar|boolean|mapping|sequence of scalars|sequence of mappings|sequence of sequence of scalars)" doc/netplan-yaml.md > /dev/null; then + if egrep "Alias: \*\*\`$term\`\*\*|\*\*\`$term\`\*\*.*\((scalar|boolean|mapping|sequence of scalars|sequence of mappings|sequence of sequence of scalars)" doc/reference/netplan-yaml.md > /dev/null; then continue fi From 55c6895196efe5cda96cf2e9fc7b099d0f8df11a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Kr=C3=A1tk=C3=BD?= Date: Wed, 25 Sep 2024 10:44:17 +0200 Subject: [PATCH 03/11] Fix paths to reference docs for link and spellcheck. --- doc/.sphinx/spellingcheck.yaml | 2 +- doc/explanation/security.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/.sphinx/spellingcheck.yaml b/doc/.sphinx/spellingcheck.yaml index d35477ab8..4d3da33e9 100644 --- a/doc/.sphinx/spellingcheck.yaml +++ b/doc/.sphinx/spellingcheck.yaml @@ -9,7 +9,7 @@ matrix: - .custom_wordlist.txt output: .sphinx/.wordlist.dic sources: - - _build/**/*.html|!_build/genindex/index.html|!_build/apidoc/**/*.html + - _build/**/*.html|!_build/genindex/index.html|!_build/reference/apidoc/**/*.html pipeline: - pyspelling.filters.html: comments: false diff --git a/doc/explanation/security.md b/doc/explanation/security.md index e9d099be8..89c285b45 100644 --- a/doc/explanation/security.md +++ b/doc/explanation/security.md @@ -61,7 +61,7 @@ varying key lengths of RSA, DSA, ECDSA, ECDH and EdDSA. ### Cryptographic technology exposed to the user Netplan allows to configure certain cryptographic technology that can be -described in its {doc}`netplan-yaml`. Notable settings include the +described in its {doc}`../reference/netplan-yaml`. Notable settings include the {ref}`yaml-auth` block, e.g. `auth.password` can be used configure `WPA-PSK` or `WPA-EAP` secrets, which can also be a special `hash:...` value for `wpa_supplicant`. The `auth.method` field controls the technology, such as From 5edc88e4ddc8fef7a1b2465de561a99d5083aa04 Mon Sep 17 00:00:00 2001 From: davidekete Date: Wed, 25 Sep 2024 18:55:19 +0100 Subject: [PATCH 04/11] docs: Rename main files to index.md --- doc/explanation/{explanation.md => index.md} | 0 doc/howto/{howto.md => index.md} | 0 doc/index.md | 8 ++++---- doc/reference/{reference.md => index.md} | 0 doc/tutorial/{tutorial.md => index.md} | 0 5 files changed, 4 insertions(+), 4 deletions(-) rename doc/explanation/{explanation.md => index.md} (100%) rename doc/howto/{howto.md => index.md} (100%) rename doc/reference/{reference.md => index.md} (100%) rename doc/tutorial/{tutorial.md => index.md} (100%) diff --git a/doc/explanation/explanation.md b/doc/explanation/index.md similarity index 100% rename from doc/explanation/explanation.md rename to doc/explanation/index.md diff --git a/doc/howto/howto.md b/doc/howto/index.md similarity index 100% rename from doc/howto/howto.md rename to doc/howto/index.md diff --git a/doc/index.md b/doc/index.md index 41eec6681..07b657ef1 100644 --- a/doc/index.md +++ b/doc/index.md @@ -4,10 +4,10 @@ :maxdepth: 2 :hidden: true -tutorial/tutorial -howto/howto -reference/reference -explanation/explanation +tutorial/index +howto/index +reference/index +explanation/index ``` **Netplan** is a network configuration abstraction renderer. diff --git a/doc/reference/reference.md b/doc/reference/index.md similarity index 100% rename from doc/reference/reference.md rename to doc/reference/index.md diff --git a/doc/tutorial/tutorial.md b/doc/tutorial/index.md similarity index 100% rename from doc/tutorial/tutorial.md rename to doc/tutorial/index.md From ab9d501b32701fb5ea692548214f026fee6a410a Mon Sep 17 00:00:00 2001 From: davidekete Date: Wed, 25 Sep 2024 21:32:30 +0100 Subject: [PATCH 05/11] docs: fix broken links --- doc/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/index.md b/doc/index.md index 07b657ef1..a39b5c913 100644 --- a/doc/index.md +++ b/doc/index.md @@ -44,13 +44,13 @@ systemd-networkd. :reverse: :::{grid-item-card} **[Reference](reference/reference)** -:link: reference/reference +:link: reference/index :link-type: doc **Technical information** - specifications, APIs, architecture ::: :::{grid-item-card} **[Explanation](explanation/explanation)** -:link: explanation/explanation +:link: explanation/index :link-type: doc **Discussion and clarification** of key topics From bef42bc348a6b71496337011fbe59f8163c566b6 Mon Sep 17 00:00:00 2001 From: davidekete Date: Fri, 27 Sep 2024 14:09:04 +0100 Subject: [PATCH 06/11] docs: add redirects --- doc/conf.py | 2 +- doc/index.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 2e06d63d6..0e8f0b8a9 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -121,7 +121,7 @@ redirects = { 'README.md': '/', - 'netplan': '/netplan-yaml', + 'netplan': '/reference/netplan-yaml', } ############################################################ diff --git a/doc/index.md b/doc/index.md index a39b5c913..c6f90de00 100644 --- a/doc/index.md +++ b/doc/index.md @@ -43,13 +43,13 @@ systemd-networkd. ::::{grid} 1 1 2 2 :reverse: -:::{grid-item-card} **[Reference](reference/reference)** +:::{grid-item-card} **[Reference](reference/index)** :link: reference/index :link-type: doc **Technical information** - specifications, APIs, architecture ::: -:::{grid-item-card} **[Explanation](explanation/explanation)** +:::{grid-item-card} **[Explanation](explanation/index)** :link: explanation/index :link-type: doc From 37f602e4c456b2bd8ebb988c944a88edb36c62e2 Mon Sep 17 00:00:00 2001 From: davidekete Date: Sun, 20 Oct 2024 01:14:37 +0100 Subject: [PATCH 07/11] docs: fix slyons comments --- doc/conf.py | 1 + doc/howto/multi-nic-vm-host-with-bonds-and-vlans.md | 10 +++++----- doc/howto/single-nic-vm-host-with-vlans.md | 12 ++++++------ doc/howto/single-nic-vm-host.md | 10 +++++----- 4 files changed, 17 insertions(+), 16 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 0e8f0b8a9..9c75758a0 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -122,6 +122,7 @@ redirects = { 'README.md': '/', 'netplan': '/reference/netplan-yaml', + 'netplan-yaml': '/reference/netplan-yaml', } ############################################################ diff --git a/doc/howto/multi-nic-vm-host-with-bonds-and-vlans.md b/doc/howto/multi-nic-vm-host-with-bonds-and-vlans.md index 76a010ec1..2c1d9dfbf 100644 --- a/doc/howto/multi-nic-vm-host-with-bonds-and-vlans.md +++ b/doc/howto/multi-nic-vm-host-with-bonds-and-vlans.md @@ -3,7 +3,7 @@ This guide shows how to configure a virtual machine (VM) host using Netplan and the `virsh` interface. The host in this scenario has four network interface (NICs). The host uses network bonding and three VLAN networks. -```{include} reuse/configure-vm-prerequisites.md +```{include} ../reuse/configure-vm-prerequisites.md ``` @@ -35,7 +35,7 @@ This guide shows how to configure a virtual machine (VM) host using Netplan and - Firewall configured; see [UFW](https://help.ubuntu.com/community/UFW). -```{include} reuse/configure-vm-disable-netfilter.md +```{include} ../reuse/configure-vm-disable-netfilter.md ``` @@ -141,16 +141,16 @@ Configure Netplan: ``` -```{include} reuse/configure-vm-using-virsh.md +```{include} ../reuse/configure-vm-using-virsh.md ``` -```{include} reuse/configure-vm-check-networking-delete-default.md +```{include} ../reuse/configure-vm-check-networking-delete-default.md ``` -```{include} reuse/configure-vm-create-bridged-networks.md +```{include} ../reuse/configure-vm-create-bridged-networks.md ``` \ No newline at end of file diff --git a/doc/howto/single-nic-vm-host-with-vlans.md b/doc/howto/single-nic-vm-host-with-vlans.md index b1e4dc643..765cdf239 100644 --- a/doc/howto/single-nic-vm-host-with-vlans.md +++ b/doc/howto/single-nic-vm-host-with-vlans.md @@ -3,12 +3,12 @@ This guide shows how to configure a virtual machine (VM) host using Netplan and the `virsh` interface. The host in this scenario has a single network interface (NIC) and three VLAN networks. -```{include} reuse/configure-vm-prerequisites.md +```{include} ../reuse/configure-vm-prerequisites.md ``` -```{include} reuse/configure-vm-prerequisites-system.md +```{include} ../reuse/configure-vm-prerequisites-system.md ``` @@ -29,7 +29,7 @@ This guide shows how to configure a virtual machine (VM) host using Netplan and - Firewall configured; see [UFW](https://help.ubuntu.com/community/UFW). -```{include} reuse/configure-vm-disable-netfilter.md +```{include} ../reuse/configure-vm-disable-netfilter.md ``` @@ -118,16 +118,16 @@ Configure Netplan: ``` -```{include} reuse/configure-vm-using-virsh.md +```{include} ../reuse/configure-vm-using-virsh.md ``` -```{include} reuse/configure-vm-check-networking-delete-default.md +```{include} ../reuse/configure-vm-check-networking-delete-default.md ``` -```{include} reuse/configure-vm-create-bridged-networks.md +```{include} ../reuse/configure-vm-create-bridged-networks.md ``` \ No newline at end of file diff --git a/doc/howto/single-nic-vm-host.md b/doc/howto/single-nic-vm-host.md index aca0168f1..19fa08e4e 100644 --- a/doc/howto/single-nic-vm-host.md +++ b/doc/howto/single-nic-vm-host.md @@ -3,12 +3,12 @@ This guide shows how to configure a virtual-machine host using Netplan and the `virsh` interface. The host in this scenario has a single network interface. -```{include} reuse/configure-vm-prerequisites.md +```{include} ../reuse/configure-vm-prerequisites.md ``` -```{include} reuse/configure-vm-prerequisites-system.md +```{include} ../reuse/configure-vm-prerequisites-system.md ``` @@ -26,7 +26,7 @@ This guide shows how to configure a virtual-machine host using Netplan and the ` - Firewall configured; see [UFW](https://help.ubuntu.com/community/UFW). -```{include} reuse/configure-vm-disable-netfilter.md +```{include} ../reuse/configure-vm-disable-netfilter.md ``` @@ -81,12 +81,12 @@ Configure Netplan: ``` -```{include} reuse/configure-vm-using-virsh.md +```{include} ../reuse/configure-vm-using-virsh.md ``` -```{include} reuse/configure-vm-check-networking-delete-default.md +```{include} ../reuse/configure-vm-check-networking-delete-default.md ``` From 274cdde621e9ad388ddcaeb0ec58ef8d74fce099 Mon Sep 17 00:00:00 2001 From: davidekete Date: Sun, 20 Oct 2024 01:20:31 +0100 Subject: [PATCH 08/11] docs: fix conflict --- doc/reference/netplan-yaml.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/reference/netplan-yaml.md b/doc/reference/netplan-yaml.md index 998b06c05..9d4798f7b 100644 --- a/doc/reference/netplan-yaml.md +++ b/doc/reference/netplan-yaml.md @@ -499,7 +499,7 @@ Match devices by MAC when setting options like: `wakeonlan` or `*-offload`. > "XX:XX:XX:XX:XX:XX". The following special options are also accepted: > `permanent` and `random`. > In addition to these options, the NetworkManager renderer also accepts - > `stable` and `preserve`. + > `stable`, `stable-ssid` (Wi-Fi only) and `preserve`. > > **Note:** This will not work reliably for devices matched by name > only and rendered by networkd, due to interactions with device @@ -2192,4 +2192,4 @@ consumer of that back end. Currently, this is only used with `NetworkManager`. > Can be used as a fallback mechanism to missing key-file settings. - + \ No newline at end of file From 09796a07ebb675ba053b6c2d2b4a84580089d172 Mon Sep 17 00:00:00 2001 From: davidekete Date: Sun, 20 Oct 2024 02:14:53 +0100 Subject: [PATCH 09/11] fix: revert redirect --- doc/conf.py | 1 - 1 file changed, 1 deletion(-) diff --git a/doc/conf.py b/doc/conf.py index 9c75758a0..0e8f0b8a9 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -122,7 +122,6 @@ redirects = { 'README.md': '/', 'netplan': '/reference/netplan-yaml', - 'netplan-yaml': '/reference/netplan-yaml', } ############################################################ From 74a74041f113e04560781d941728c58246267135 Mon Sep 17 00:00:00 2001 From: davidekete Date: Fri, 25 Oct 2024 01:10:03 +0100 Subject: [PATCH 10/11] add redirects --- doc/conf.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/conf.py b/doc/conf.py index 0e8f0b8a9..9174734cd 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -122,6 +122,8 @@ redirects = { 'README.md': '/', 'netplan': '/reference/netplan-yaml', + 'netplan-everywhere': '/howto/netplan-everywhere', + 'netplan-yaml': '/reference/netplan-yaml', } ############################################################ From c5c732b0207883a044861d8e2cea41efb469a54c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lukas=20M=C3=A4rdian?= Date: Wed, 30 Oct 2024 10:28:35 +0100 Subject: [PATCH 11/11] doc:conf: Make top-level redirects relative --- doc/conf.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 9174734cd..82dccb07c 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -120,10 +120,10 @@ # For example: 'explanation/old-name.html': '../how-to/prettify.html', redirects = { - 'README.md': '/', - 'netplan': '/reference/netplan-yaml', - 'netplan-everywhere': '/howto/netplan-everywhere', - 'netplan-yaml': '/reference/netplan-yaml', + 'README.md': '../', + 'netplan': '../reference/netplan-yaml', + 'netplan-everywhere': '../howto/netplan-everywhere', + 'netplan-yaml': '../reference/netplan-yaml', } ############################################################