doc(nocloud): Document network-config file

[holmanb]

Additional Context

Based on #5193 (review)

[blackboxsw]

LGTM, couple of nits.

[holmanb]

@blackboxsw I think that I've addressed your comments.

[blackboxsw]

LGTM, minor typo and a question about command line vs commandline.

[blackboxsw]

Non-blocking comment: I think it's "command line" not commandline. But I see we are mixed throughout our docs 15 count of commandline 25 count of "command line".

Suggested change

	commandline or SMBIOS. When configured in a ``*.cfg`` file, the long key
	command line or SMBIOS. When configured in a ``*.cfg`` file, the long key

[holmanb]

will update the 15 incorrect instances of commandline

[holmanb]

@blackboxsw I've updated the docs, docstrings comments in cloud-init, and user-facing text with the correct spelling. Some file names and function names remain incorrect, but fixing those would be more invasive so for now they stay.

[blackboxsw]

Let's avoid doc file renaming throughout unless we have a really compelling reason This causes the generated docs generated to be new html pages and routes and we'd also need to setup redirect rules in RTD for each of these changes in the event of external links in blog posts etc.

[blackboxsw]

Sorry this comment of mine was arbitrary and we should do what is right and more clear for end users without concern for any extra redirects we may need to setup to facilitate better naming of docs and files. kernel_command_line is much more clear a slug than kernel_cmdline for future doc readers, so let's just do it. I've reverted your latest commit which changed just this and added the necessary redirect configuration in readthedocs.org for this redirect forwarding from kernel-cmdline.html -> kernel-command-line.html. /Me backs down on this perspective and just fixes this branch as you had it.

[blackboxsw]

Changes look good thanks, let's just avoid any top-level docs file renames to avoid thrashing with potential external links to cloud-init docs.

[blackboxsw]

Let's avoid rst doc file renames, otherwise +1.

[github-actions]

Hello! Thank you for this proposed change to cloud-init. This pull request is now marked as stale as it has not seen any activity in 14 days. If no activity occurs within the next 7 days, this pull request will automatically close.

If you are waiting for code review and you are seeing this message, apologies! Please reply, tagging TheRealFalcon, and he will ensure that someone takes a look soon.

(If the pull request is closed and you would like to continue working on it, please do tag TheRealFalcon to reopen it.)

[blackboxsw]

LGTM. I've reverted your last commit based on the fact that I disagree with my former review comment. We should move toward the best represented document names/slugs/urls we can and sort historic links/aliases and redirects appropriately in RTD configuration. Eventually be may run out of redirects on the project for renames as I think we may be capped at 100 redirects on the proejct, but it makes little sense to avoid common sense URL/slug/page renames which improve discoverability an use common terminology throughout cloud-init.

[blackboxsw]

Sorry this comment of mine was arbitrary and we should do what is right and more clear for end users without concern for any extra redirects we may need to setup to facilitate better naming of docs and files. kernel_command_line is much more clear a slug than kernel_cmdline for future doc readers, so let's just do it. I've reverted your latest commit which changed just this and added the necessary redirect configuration in readthedocs.org for this redirect forwarding from kernel-cmdline.html -> kernel-command-line.html. /Me backs down on this perspective and just fixes this branch as you had it.

[blackboxsw]

We can drop this now given we autolabel sections perform section autolabels. This means instead our cross references will be :ref:'explanation/kernel-command-line:Kernel command line' instead of adding anchors where we have sections throughout code