user-guide icon indicating copy to clipboard operation
user-guide copied to clipboard

User guide restructure with folder hierarchy

Open aburdenthehand opened this issue 9 months ago • 5 comments

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.

Release note:

Restructuring the user guide for better defined content

aburdenthehand avatar May 02 '24 10:05 aburdenthehand

@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!

aburdenthehand avatar May 03 '24 09:05 aburdenthehand

/hold Until redirects are in place.

aburdenthehand avatar May 03 '24 09:05 aburdenthehand

@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 avatar May 03 '24 13:05 jean-edouard

@jean-edouard Thanks for taking a look :) I've moved live_migration to compute as suggested.

aburdenthehand avatar May 03 '24 14:05 aburdenthehand

/hold cancel Redirect file now included

aburdenthehand avatar May 13 '24 13:05 aburdenthehand

/lgtm /approve

A step in the right direction! Follow-up PRs (posted by sig members) should organize their sections

phoracek avatar May 16 '24 15:05 phoracek

[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

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment Approvers can cancel approval by writing /approve cancel in a comment

kubevirt-bot avatar May 16 '24 15:05 kubevirt-bot