canonical / open-documentation-academy

Learn open-source software documentation skills with Canonical
https://canonical.com/documentation
Apache License 2.0
48 stars 28 forks source link

Netplan: Add guidance on setting up how-to environment #106

Open rkratky opened 1 week ago

rkratky commented 1 week ago

Context

Three of the how-to guides for Netplan feature very similar scenarios, and all of them start with the user having to configure their environment in a specific way. These are the how-tos:

In the beginning of each how-to, the user is asked to set up their networking, but specific instructions on how to perform such set up are missing.

Task

Either develop the content (instructions) on how to set up the environment at the beginning of each how-to and include it in the how-tos, or find suitable instructions in other docs and link to them (such as in existing Netplan how-tos).

Given there are a number of things that need to be set up, it's perfectly fine to provide instructions just for one or more of those -- you don't need to worry about not describing every single detail of the setup. Any improvement is worth it.

Note: It is rather probable that the same instructions on environment setup will apply to all three of the how-tos (or just with minor adjustments).

Reference