Merge pull request lxc#1534 from bensmrs/main

doc: Contributing section restructuring

doc/README.md

@@ -4,11 +4,9 @@ The Incus documentation is available at: <https://linuxcontainers.org/incus/docs
 
 GitHub provides a basic rendering of the documentation as well, but important features like includes and clickable links are missing. Therefore, we recommend reading the [published documentation](https://linuxcontainers.org/incus/docs/main/).
 
-## How it works
-
 <!-- Include start docs -->
 
-### Documentation framework
+## Documentation framework
 
 Incus' documentation is built with [Sphinx](https://www.sphinx-doc.org/en/master/index.html).
 
@@ -17,7 +15,7 @@ For syntax help and guidelines, see the [documentation cheat sheet](https://linu
 
 For structuring, the documentation uses the [Diátaxis](https://diataxis.fr/) approach.
 
-### Build the documentation
+## Build the documentation
 
 To build the documentation, run `make doc` from the root directory of the repository.
 This command installs the required tools and renders the output to the `doc/html/` directory.

doc/contributing.md

@@ -1,124 +1,9 @@
-# How to contribute to Incus
+# Contributing to Incus
 
-% Include content from [../CONTRIBUTING.md](../CONTRIBUTING.md)
-```{include} ../CONTRIBUTING.md
-    :start-after: <!-- Include start contributing -->
-    :end-before: <!-- Include end contributing -->
-```
-
-## Contribute to the code
-
-Follow the steps below to set up your development environment to get started working on new features for Incus.
-
-### Install Incus from source
-
-To build the dependencies, follow the instructions in {ref}`installing_from_source`.
-
-### Add your fork as a remote
-
-After setting up your build environment, add your GitHub fork as a remote:
-
-    git remote add myfork [email protected]:<your_username>/incus.git
-    git remote update
-
-Then switch to it:
-
-    git checkout myfork/main
+```{toctree}
+:maxdepth: 1
 
-### Build Incus
-
-Finally, you should be able to run `make` inside the repository and build your fork of the project.
-
-At this point, you most likely want to create a new branch for your changes on your fork:
-
-```bash
-git checkout -b [name_of_your_new_branch]
-git push myfork [name_of_your_new_branch]
+Introduction </contributing/introduction>
+Contribute to the code </contributing/code>
+Contribute to the documentation </contributing/docs>
 ```
-
-### Important notes for new Incus contributors
-
-- Persistent data is stored in the `INCUS_DIR` directory, which is generated by `incus admin init`.
-  The `INCUS_DIR` defaults to `/var/lib/incus`.
-- As you develop, you may want to change the `INCUS_DIR` for your fork of Incus so as to avoid version conflicts.
-- Binaries compiled from your source will be generated in the `$(go env GOPATH)/bin` directory by default.
-   - You will need to explicitly invoke these binaries (not the global `incusd` you may have installed) when testing your changes.
-   - You may choose to create an alias in your `~/.bashrc` to call these binaries with the appropriate flags more conveniently.
-- If you have a `systemd` service configured to run the Incus daemon from a previous installation of Incus, you may want to disable it to avoid version conflicts.
-
-## Contribute to the documentation
-
-We want Incus to be as easy and straight-forward to use as possible.
-Therefore, we aim to provide documentation that contains the information that users need to work with Incus, that covers all common use cases, and that answers typical questions.
-
-You can contribute to the documentation in various different ways.
-We appreciate your contributions!
-
-Typical ways to contribute are:
-
-- Add or update documentation for new features or feature improvements that you contribute to the code.
-  We'll review the documentation update and merge it together with your code.
-- Add or update documentation that clarifies any doubts you had when working with the product.
-  Such contributions can be done through a pull request or through a post in the [Tutorials](https://discuss.linuxcontainers.org/c/tutorials/16) section on the forum.
-  New tutorials will be considered for inclusion in the docs (through a link or by including the actual content).
-- To request a fix to the documentation, open a documentation issue on [GitHub](https://github.com/lxc/incus/issues).
-  We'll evaluate the issue and update the documentation accordingly.
-- Post a question or a suggestion on the [forum](https://discuss.linuxcontainers.org).
-  We'll monitor the posts and, if needed, update the documentation accordingly.
-- Ask questions or provide suggestions in the `#lxc` channel on [IRC](https://web.libera.chat/#lxc).
-  Given the dynamic nature of IRC, we cannot guarantee answers or reactions to IRC posts, but we monitor the channel and try to improve our documentation based on the received feedback.
-
-% Include content from [README.md](README.md)
-```{include} README.md
-    :start-after: <!-- Include start docs -->
-```
-
-When you open a pull request, a preview of the documentation output is built automatically.
-
-### Automatic documentation checks
-
-GitHub runs automatic checks on the documentation to verify the spelling, the validity of links, correct formatting of the Markdown files, and the use of inclusive language.
-
-You can (and should!) run these tests locally as well with the following commands:
-
-- Check the spelling: `make doc-spellcheck`
-- Check the validity of links: `make doc-linkcheck`
-- Check the Markdown formatting: `make doc-lint`
-- Check for inclusive language: `make doc-woke`
-
-To run the above, you will need the following:
-
-- Python 3.8 or higher
-- The `venv` python package
-- The `aspell` tool for spellchecking
-- The `mdl` markdown lint tool
-
-### Document configuration options
-
-```{note}
-We are currently in the process of moving the documentation of configuration options to code comments.
-At the moment, not all configuration options follow this approach.
-```
-
-The documentation of configuration options is extracted from comments in the Go code.
-Look for comments that start with `gendoc:generate` in the code.
-
-When you add or change a configuration option, make sure to include the required documentation comment for it.
-
-Then run `make generate-config` to re-generate the `doc/config_options.txt` file.
-The updated file should be checked in.
-
-The documentation includes sections from the `doc/config_options.txt` to display a group of configuration options.
-For example, to include the core server options:
-
-````
-% Include content from [config_options.txt](config_options.txt)
-```{include} config_options.txt
-    :start-after: <!-- config group server-core start -->
-    :end-before: <!-- config group server-core end -->
-```
-````
-
-If you add a configuration option to an existing group, you don't need to do any updates to the documentation files.
-The new option will automatically be picked up.
-You only need to add an include to a documentation file if you are defining a new group.

doc/contributing/code.md

@@ -0,0 +1,39 @@
+# Contribute to the code
+
+Follow the steps below to set up your development environment to get started working on new features for Incus.
+
+## Install Incus from source
+
+To build the dependencies, follow the instructions in {ref}`installing_from_source`.
+
+## Add your fork as a remote
+
+After setting up your build environment, add your GitHub fork as a remote:
+
+    git remote add myfork [email protected]:<your_username>/incus.git
+    git remote update
+
+Then switch to it:
+
+    git checkout myfork/main
+
+## Build Incus
+
+Finally, you should be able to run `make` inside the repository and build your fork of the project.
+
+At this point, you most likely want to create a new branch for your changes on your fork:
+
+```bash
+git checkout -b [name_of_your_new_branch]
+git push myfork [name_of_your_new_branch]
+```
+
+## Important notes for new Incus contributors
+
+- Persistent data is stored in the `INCUS_DIR` directory, which is generated by `incus admin init`.
+  The `INCUS_DIR` defaults to `/var/lib/incus`.
+- As you develop, you may want to change the `INCUS_DIR` for your fork of Incus so as to avoid version conflicts.
+- Binaries compiled from your source will be generated in the `$(go env GOPATH)/bin` directory by default.
+   - You will need to explicitly invoke these binaries (not the global `incusd` you may have installed) when testing your changes.
+   - You may choose to create an alias in your `~/.bashrc` to call these binaries with the appropriate flags more conveniently.
+- If you have a `systemd` service configured to run the Incus daemon from a previous installation of Incus, you may want to disable it to avoid version conflicts.

doc/contributing/docs.md

@@ -0,0 +1,76 @@
+# Contribute to the documentation
+
+We want Incus to be as easy and straight-forward to use as possible.
+Therefore, we aim to provide documentation that contains the information that users need to work with Incus, that covers all common use cases, and that answers typical questions.
+
+You can contribute to the documentation in various different ways.
+We appreciate your contributions!
+
+Typical ways to contribute are:
+
+- Add or update documentation for new features or feature improvements that you contribute to the code.
+  We'll review the documentation update and merge it together with your code.
+- Add or update documentation that clarifies any doubts you had when working with the product.
+  Such contributions can be done through a pull request or through a post in the [Tutorials](https://discuss.linuxcontainers.org/c/tutorials/16) section on the forum.
+  New tutorials will be considered for inclusion in the docs (through a link or by including the actual content).
+- To request a fix to the documentation, open a documentation issue on [GitHub](https://github.com/lxc/incus/issues).
+  We'll evaluate the issue and update the documentation accordingly.
+- Post a question or a suggestion on the [forum](https://discuss.linuxcontainers.org).
+  We'll monitor the posts and, if needed, update the documentation accordingly.
+- Ask questions or provide suggestions in the `#lxc` channel on [IRC](https://web.libera.chat/#lxc).
+  Given the dynamic nature of IRC, we cannot guarantee answers or reactions to IRC posts, but we monitor the channel and try to improve our documentation based on the received feedback.
+
+% Include content from [../README.md](../README.md)
+```{include} ../README.md
+    :start-after: <!-- Include start docs -->
+```
+
+When you open a pull request, a preview of the documentation output is built automatically.
+
+## Automatic documentation checks
+
+GitHub runs automatic checks on the documentation to verify the spelling, the validity of links, correct formatting of the Markdown files, and the use of inclusive language.
+
+You can (and should!) run these tests locally as well with the following commands:
+
+- Check the spelling: `make doc-spellcheck`
+- Check the validity of links: `make doc-linkcheck`
+- Check the Markdown formatting: `make doc-lint`
+- Check for inclusive language: `make doc-woke`
+
+To run the above, you will need the following:
+
+- Python 3.8 or higher
+- The `venv` python package
+- The `aspell` tool for spellchecking
+- The `mdl` markdown lint tool
+
+## Document configuration options
+
+```{note}
+We are currently in the process of moving the documentation of configuration options to code comments.
+At the moment, not all configuration options follow this approach.
+```
+
+The documentation of configuration options is extracted from comments in the Go code.
+Look for comments that start with `gendoc:generate` in the code.
+
+When you add or change a configuration option, make sure to include the required documentation comment for it.
+
+Then run `make generate-config` to re-generate the `doc/config_options.txt` file.
+The updated file should be checked in.
+
+The documentation includes sections from the `doc/config_options.txt` to display a group of configuration options.
+For example, to include the core server options:
+
+````
+% Include content from [config_options.txt](config_options.txt)
+```{include} config_options.txt
+    :start-after: <!-- config group server-core start -->
+    :end-before: <!-- config group server-core end -->
+```
+````
+
+If you add a configuration option to an existing group, you don't need to do any updates to the documentation files.
+The new option will automatically be picked up.
+You only need to add an include to a documentation file if you are defining a new group.

doc/contributing/introduction.md

@@ -0,0 +1,7 @@
+# How to contribute to Incus
+
+% Include content from [../../CONTRIBUTING.md](../../CONTRIBUTING.md)
+```{include} ../../CONTRIBUTING.md
+    :start-after: <!-- Include start contributing -->
+    :end-before: <!-- Include end contributing -->
+```

doc/general.md

@@ -10,7 +10,6 @@ Install Incus </installing>
 Initialize Incus </howto/initialize>
 Get support </support>
 Frequently asked </faq>
-Contribute to Incus </contributing>
 ```
 
 You can find a series of demos and tutorials on YouTube:

doc/index.md

@@ -58,5 +58,6 @@ Clustering </clustering>
 API </api>
 Security </security>
 Internals </internals>
+Contributing </contributing>
 External resources </external_resources>
 ```