docs: Adding howto guides for CVEs/USN #3116
Conversation
dheyay
force-pushed
the
cve-howto-guides
branch
2 times, most recently
from
ac7a80f
to
69ed0e0
Compare
|
Directly dependent on:
These need to be reviewed/approved before the howto guides are approved. |
docs/howtoguides.rst
Outdated
| @@ -104,10 +104,15 @@ Ubuntu Pro Client for Clouds | |||
| Create a customised Cloud Ubuntu Pro image <howtoguides/create_pro_golden_image> | |||
| Cloud Ubuntu Pro images with FIPS updates <howtoguides/create_a_fips_updates_pro_cloud_image> | |||
|
|
|||
| Fixing multiple CVEs | |||
| ==================== | |||
| CVE/USN resolution | |||
There was a problem hiding this comment.
With headers (especially in how-tos) I tend to try and use language that feels a bit more "active" because it reflects the sort of keywords users might use when they're searching the docs for something. In this case I'd recommend switching this to something more like "Resolve CVEs and USNs" or "Fixing CVEs and USNs". I'll let you have a think and decide what wording you want to use, I would just always avoid using words ending in "-tion" because they don't come up in searches very often.
There was a problem hiding this comment.
Now that I think of it, makes much more sense to have something like "Fixing multiple CVEs and USNs"
| This is not the only scenario where you might want to use ``pro fix``. To find out about the other situations where it can be useful, as well as which options can be used to give you greater control over the command, you can refer to the following guides: | ||
|
|
||
| * In :ref:`Understanding scenarios encountered when using pro fix to solve a CVE/USN <pro-fix-howto>` you can continue learning more about the different scenarios you might encounter and understand the different outputs you will find. | ||
| * :ref:`How do I know what the pro fix command would change? <pro-fix-dry-run>` will show you how to use ``pro fix`` in ``--dry-run`` mode to safely simulate the changes before they're applied. |
There was a problem hiding this comment.
I'm now wondering - did we not already show how to do that in this page? Do we need to combine pages?
There was a problem hiding this comment.
I think so too, these two pages overlap in the information presented but the main difference I think from a user point of view is what the information presented represents. In one case it is for a user who is planning to use the fix command and wants to know what will change, on the other hand, the current added page let's the user check if the CVE affects their system or not.
It is basically the same thing but packaged differently for the ease of reading. let me know if you think we should actually just merge these into one. However, I think having these two guides as different pages answer different questions (I don't know how feasible it is to have both of them though}
Why is this needed?
This PR solves all of our problems because it adds the following guides to documentation
Test Steps
Checklist
Does this PR require extra reviews?