docs: structure: move packaging related pages

Bring more structure into the docs by moving packaging related subpages
as well.

Signed-off-by: Oliver Smith <ollieparanoid@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/8812>

.gitignore

@@ -67,7 +67,7 @@ instance/
 
 # Documentation
 public
-docs/deviceinfo-reference.md
+docs/packaging/device-packages/deviceinfo-reference.md
 
 # PyBuilder
 target/

docs/conf.py

@@ -31,14 +31,25 @@ html_title = "postmarketOS Packaging"
 redirects = {
     "approval-rules": "merge-requests/approval-rules.html",
     "ci-tags": "ci/ci-tags.html",
+    "device-categorization": "packaging/device-categorization.html",
+    "deviceinfo-reference": "packaging/device-packages/deviceinfo-reference.html",
+    "firmware": "packaging/firmware-packages.html",
+    "generic-device-packages": "packaging/device-packages/generic-device-packages.html",
+    "generic-kernels": "packaging/kernel-packages/generic-kernel-packages.html",
     "hardware-ci": "ci/hardware-ci.html",
+    "kconfig-fragments": "packaging/kernel-packages/kconfig-fragments.html",
+    "kconfigcheck": "packaging/kernel-packages/kconfigcheck.html",
+    "kernel-cmdline": "packaging/kernel-packages/kernel-cmdline.html",
+    "kernel-versions": "packaging/kernel-packages/kernel-versions.html",
+    "packaging-guidelines": "packaging.html",
     "releases/backporting": "merge-requests/stable-branches.html",
+    "ui-packages": "packaging/ui-packages.html",
 }
 
 def run_dint_doc(app):
     docs_dir = Path(__file__).parent
 
-    with docs_dir.joinpath("deviceinfo-reference.md").open("w") as f:
+    with docs_dir.joinpath("packaging/device-packages/deviceinfo-reference.md").open("w") as f:
         schema_path = docs_dir.parent / "deviceinfo_schema.toml"
 
         subprocess.run(["dint", "doc"], stdout=f, check=True, env={"DINT_SCHEMA_PATH": schema_path})

docs/index.md

@@ -15,16 +15,6 @@ in pmaports and the processes around device categorization.
 
    releases
    merge-requests
-   device-categorization
-   deviceinfo-reference
    ci
-   firmware
+   packaging
-   generic-device-packages
-   generic-kernels
-   kconfig-fragments
-   kconfigcheck
-   kernel-cmdline
-   kernel-versions
-   packaging-guidelines
-   ui-packages
 ```

docs/merge-requests/approval-rules.md

@@ -33,12 +33,12 @@ The following flowchart describes the process:
 ## Move device from category
 
 Moving devices from category is a special operation, see
-[device categorization](../device-categorization).
+[device categorization](../packaging/device-categorization).
 
 ## Changing kconfigcheck requirements
 
 Changes to `kconfigcheck.toml` are a special operation, see
-[kconfigcheck](../kconfigcheck).
+[kconfigcheck](../packaging/kernel-packages/kconfigcheck).
 
 ## Testing requirements
 

docs/packaging.md

@@ -315,3 +315,16 @@ only in some specific circumstances? In those situations we have to:
     versioned provider to disambiguate (e.g:
     `provides="audio-conf=$pkgver-r$pkgrel"`), or to force the forked packages
     to provide a lower version than the other package.
+
+```{eval-rst}
+.. toctree::
+   :hidden:
+
+   packaging/device-categorization
+
+   packaging/device-packages
+   packaging/kernel-packages
+
+   packaging/firmware-packages
+   packaging/ui-packages
+```

docs/packaging/device-categorization.md

@@ -224,7 +224,7 @@ requested time pass and the device still does not meet the criteria, a merge
 request to move them to the now appropriate category should be opened.
 
 Merge requests moving a device to a lower category are subject to the standard
-[pmaports approval rules](./merge-requests/approval-rules).
+[pmaports approval rules](../merge-requests/approval-rules).
 
 ## See also
 

docs/packaging/device-packages.md

@@ -0,0 +1,12 @@
+# Device Packages
+
+Device packges in pmaports start with `device-`.
+
+```{eval-rst}
+.. toctree::
+   :hidden:
+
+   device-packages/generic-device-packages
+   device-packages/deviceinfo-reference
+```
+

docs/packaging/kernel-packages.md

@@ -0,0 +1,14 @@
+# Kernel Packages
+
+Kernel packages in pmaports start with `linux-`.
+
+```{eval-rst}
+.. toctree::
+   :hidden:
+
+   kernel-packages/generic-kernel-packages
+   kernel-packages/kconfig-fragments
+   kernel-packages/kconfigcheck
+   kernel-packages/kernel-cmdline
+   kernel-packages/kernel-versions
+```

docs/packaging/kernel-packages/kconfigcheck.md

@@ -47,7 +47,7 @@ This would opt into the `community` category checks. The checks can be
 performed by running `pmbootstrap kconfig check [kernel-package-name]`.
 The `community` category checks are mandatory for devices in the community
 and main categories, see the
-[device categorization requirements](./device-categorization) for more
+[device categorization requirements](../device-categorization) for more
 information.
 
 ## Version baselines
@@ -79,7 +79,7 @@ package maintainers, who must make sure their kernel complies with the changed
 requirements in the next update to their kernel packages. When making unrelated
 changes to a kernel package that does not meet the current requirements, one
 can use the `[ci:skip-kconfigcheck]` CI tag to bypass the checks if
-[the situation allows for it](ci/ci-tags).
+[the situation allows for it](../../ci/ci-tags).
 
 Merge requests that change the `kconfigcheck.toml` require approval from
 members of the kconfigcheck team in GitLab. The team can be pinged on merge

docs/packaging/kernel-packages/kernel-versions.md

@@ -9,7 +9,7 @@ additional guidelines for which kernel version to package for a device.
 
 Devices with a close-to-mainline kernel usually reside in `testing` and can be
 moved to `community` or `main` later if they meet the necessary
-[requirements](./device-categorization.md). Devices using a downstream (i.e.
+[requirements](../device-categorization.md). Devices using a downstream (i.e.
 vendor-provided) kernel are packaged in the `downstream` or `archived`
 categories.