docs: Fix docs directory structure to reflect Diátaxis

canonical · Sep 24, 2024 · f038e81 · f038e81
1 parent e0e8711
commit f038e81
Show file tree

Hide file tree

Showing 40 changed files with 16 additions and 16 deletions.
diff --git 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 → doc/explanation/explanation.md b/doc/explanation.md → doc/explanation/explanation.md
diff --git a/doc/generator.md → doc/explanation/generator.md b/doc/generator.md → doc/explanation/generator.md
diff --git a/doc/nm-all.md → doc/explanation/nm-all.md b/doc/nm-all.md → doc/explanation/nm-all.md
diff --git a/doc/security.md → doc/explanation/security.md b/doc/security.md → doc/explanation/security.md
diff --git a/doc/structure-id.md → doc/explanation/structure-id.md b/doc/structure-id.md → doc/explanation/structure-id.md
diff --git a/doc/contribute-docs.md → doc/howto/contribute-docs.md b/doc/contribute-docs.md → doc/howto/contribute-docs.md
diff --git a/doc/creating-link-aggregation.md → doc/howto/creating-link-aggregation.md b/doc/creating-link-aggregation.md → doc/howto/creating-link-aggregation.md
diff --git a/doc/dbus-config.md → doc/howto/dbus-config.md b/doc/dbus-config.md → doc/howto/dbus-config.md
diff --git a/doc/examples.md → doc/howto/examples.md b/doc/examples.md → doc/howto/examples.md
diff --git a/doc/howto.md → doc/howto/howto.md b/doc/howto.md → doc/howto/howto.md
diff --git a/doc/matching-interface-by-mac-address.md → ...owto/matching-interface-by-mac-address.md b/doc/matching-interface-by-mac-address.md → ...owto/matching-interface-by-mac-address.md
diff --git a/...multi-nic-vm-host-with-bonds-and-vlans.md → ...multi-nic-vm-host-with-bonds-and-vlans.md b/...multi-nic-vm-host-with-bonds-and-vlans.md → ...multi-nic-vm-host-with-bonds-and-vlans.md
diff --git a/doc/netplan-everywhere.md → doc/howto/netplan-everywhere.md b/doc/netplan-everywhere.md → doc/howto/netplan-everywhere.md
diff --git a/doc/single-nic-vm-host-with-vlans.md → doc/howto/single-nic-vm-host-with-vlans.md b/doc/single-nic-vm-host-with-vlans.md → doc/howto/single-nic-vm-host-with-vlans.md
diff --git a/doc/single-nic-vm-host.md → doc/howto/single-nic-vm-host.md b/doc/single-nic-vm-host.md → doc/howto/single-nic-vm-host.md
diff --git a/doc/using-static-ip-addresses.md → doc/howto/using-static-ip-addresses.md b/doc/using-static-ip-addresses.md → doc/howto/using-static-ip-addresses.md
diff --git 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 → doc/reference/apidoc/inc-netdef.md b/doc/apidoc/inc-netdef.md → doc/reference/apidoc/inc-netdef.md
diff --git a/doc/apidoc/inc-parse-nm.md → doc/reference/apidoc/inc-parse-nm.md b/doc/apidoc/inc-parse-nm.md → doc/reference/apidoc/inc-parse-nm.md
diff --git a/doc/apidoc/inc-parse.md → doc/reference/apidoc/inc-parse.md b/doc/apidoc/inc-parse.md → doc/reference/apidoc/inc-parse.md
diff --git a/doc/apidoc/inc-state.md → doc/reference/apidoc/inc-state.md b/doc/apidoc/inc-state.md → doc/reference/apidoc/inc-state.md
diff --git a/doc/apidoc/inc-types.md → doc/reference/apidoc/inc-types.md b/doc/apidoc/inc-types.md → doc/reference/apidoc/inc-types.md
diff --git a/doc/apidoc/inc-util.md → doc/reference/apidoc/inc-util.md b/doc/apidoc/inc-util.md → doc/reference/apidoc/inc-util.md
diff --git a/doc/apidoc/index.md → doc/reference/apidoc/index.md b/doc/apidoc/index.md → doc/reference/apidoc/index.md
diff --git a/doc/cli.md → doc/reference/cli.md b/doc/cli.md → doc/reference/cli.md
diff --git a/doc/netplan-apply.md → doc/reference/netplan-apply.md b/doc/netplan-apply.md → doc/reference/netplan-apply.md
diff --git a/doc/netplan-dbus.md → doc/reference/netplan-dbus.md b/doc/netplan-dbus.md → doc/reference/netplan-dbus.md
diff --git a/doc/netplan-generate.md → doc/reference/netplan-generate.md b/doc/netplan-generate.md → doc/reference/netplan-generate.md
diff --git a/doc/netplan-get.md → doc/reference/netplan-get.md b/doc/netplan-get.md → doc/reference/netplan-get.md
diff --git a/doc/netplan-info.md → doc/reference/netplan-info.md b/doc/netplan-info.md → doc/reference/netplan-info.md
diff --git a/doc/netplan-ip.md → doc/reference/netplan-ip.md b/doc/netplan-ip.md → doc/reference/netplan-ip.md
diff --git a/doc/netplan-rebind.md → doc/reference/netplan-rebind.md b/doc/netplan-rebind.md → doc/reference/netplan-rebind.md
diff --git a/doc/netplan-set.md → doc/reference/netplan-set.md b/doc/netplan-set.md → doc/reference/netplan-set.md
diff --git a/doc/netplan-status.md → doc/reference/netplan-status.md b/doc/netplan-status.md → doc/reference/netplan-status.md
diff --git a/doc/netplan-try.md → doc/reference/netplan-try.md b/doc/netplan-try.md → doc/reference/netplan-try.md
diff --git a/doc/netplan-yaml.md → doc/reference/netplan-yaml.md b/doc/netplan-yaml.md → doc/reference/netplan-yaml.md
diff --git a/doc/reference.md → doc/reference/reference.md b/doc/reference.md → doc/reference/reference.md
diff --git a/doc/netplan-tutorial.md → doc/tutorial/netplan-tutorial.md b/doc/netplan-tutorial.md → doc/tutorial/netplan-tutorial.md
diff --git a/doc/tutorial.md → doc/tutorial/tutorial.md b/doc/tutorial.md → doc/tutorial/tutorial.md