user-guide
user-guide copied to clipboard
User guide restructure with folder hierarchy
What this PR does / why we need it:
This is an alternative to #684 - mostly the same except it uses a folder hierarchy for the sections. This was after talking to some folks in the community that it is easier to navigate than one big bucket. It also has the added benefit of being able to demarcate ownership/responsibility of a section to a SIG.
The downside of this approach is that the redirects are more complicated (a global redirect could be used for the #684 approach). AFAIK this can be done vie the mk docs redirects plugin or in netlify itself. I would lean towards the former (and a minor update to the Dockerfile in project-infra).
Edit: Oh yeah, while I was updating all the xrefs I made them all consistent (returning to root docs/ directory and including filepath) and converted some really old, dead docs urls to xrefs.
- [x] Design: A design document was considered and is present (link) or not required
- [x] PR: The PR description is expressive enough and will help future contributors
- [ ] Code: Write code that humans can understand and Keep it simple
- [x] Refactor: You have left the code cleaner than you found it (Boy Scout Rule)
- [x] Upgrade: Impact of this change on upgrade flows was considered and addressed if required
- [ ] Testing: New code requires new unit tests. New features and bug fixes require at least on e2e test
- [x] Documentation: A user-guide update was considered and is present (link) or not required. You want a user-guide update if it's a user facing feature / API change.
- [x] Community: Announcement to kubevirt-dev was considered
Release note:
Restructuring the user guide for better defined content
@jean-edouard @phoracek @alicefr @ksimon1 @machadovilaca @mhenriks @AlonaKaplan @0xFelix
Can you please have a quick look at the relevant .pages
files to ensure categorical accuracy. Thanks!
/hold Until redirects are in place.
@jean-edouard @phoracek @alicefr @ksimon1 @machadovilaca @mhenriks @AlonaKaplan @0xFelix Can you please have a quick look at the relevant
.pages
files to ensure categorical accuracy. Thanks!
Looks good to me at first glance, I would just move live_migration.md to compute. Thank you for doing this! The VM/Operations categories don't make sense, I always have to try both to find the page I'm looking for!
@jean-edouard Thanks for taking a look :) I've moved live_migration to compute as suggested.
/hold cancel Redirect file now included
/lgtm /approve
A step in the right direction! Follow-up PRs (posted by sig members) should organize their sections
[APPROVALNOTIFIER] This PR is APPROVED
This pull-request has been approved by: phoracek
The full list of commands accepted by this bot can be found here.
The pull request process is described here
- ~~OWNERS~~ [phoracek]
Approvers can indicate their approval by writing /approve
in a comment
Approvers can cancel approval by writing /approve cancel
in a comment