Netplan: Improve 'How-to contribute to docs'

[rkratky]

Context

While the Netplan docs include a how-to article with guidance on contributing to the documentation set, it could be improved by:

• Making it better findable
• Adding info about things one needs to know when submitting PRs to the Netplan repo

Task

1. Move the Contribute to docs article from the How-to section in the navigation to the top level, i.e. as a standalone link under the four Diátaxis categories in the left-hand sidebar.
2. Add a section to this how-to that would prepare the contributor for what's required when submitting a Netplan PR:
   • Short explanation of tests that need to be run in the repo's main directory
   • Prerequisites needed for the test suites to function

Reference

• Diataxis: How-to guides
• ReadTheDocs: Netplan documentation
• GitHub: netplan

[davidekete]

Hi @rkratky, I'd like to work on this

[rkratky]

Nice. Just assigned the issue to you.

[davidekete]

Hi @rkratky, I noticed another issue with the contribute to docs tutorial. It mentions that "All the documentation files are located in the doc/ directory. The doc/ directory contains sub-directories corresponding to different Diátaxis sections". This statement is wrong; the doc/ directory contains no sub-directories corresponding to different Diátaxis sections.

Can we create another issue to sort this out? We can edit the section to reflect the actual directory structure or arrange the files into their corresponding sub-directories.

[rkratky]

Right, that's an oversight -- using the doc/ directory is the usual set up, and we forgot this was not the case for Netplan when adopting the contrib. guide.

OK, I'm creating ano0ther issue to deal with that particular discrepancy. Please, ignore that part while working on this issue.

[davidekete]

Right, that's an oversight -- using the doc/ directory is the usual set up, and we forgot this was not the case for Netplan when adopting the contrib. guide.

OK, I'm creating ano0ther issue to deal with that particular discrepancy. Please, ignore that part while working on this issue.

Alright, please let me know when you create the issue so you can assign it to me.

[rkratky]

#125