mozilla-releng / relengdocs

releng docs
https://moz-releng-docs.readthedocs.io/en/latest/
10 stars 27 forks source link

refactor!: fully switch to Diataxis system #240

Closed ahal closed 1 year ago

ahal commented 1 year ago

BREAKING CHANGE: This will break pretty much every link to our docs.

Awhile back we agreed to try and implement the Diataxis documentation system: https://diataxis.fr/

However, we only moved a handful of docs over and have been in a mixed state of having docs following two separate structures (if you can call the old way a structure) ever since.

The goal of this PR is to re-organize all the docs in the old structured over to the new Diataxis-based structure. There are plenty of docs that don't fit neatly in one place or the other, so this PR often takes a best guess at where it belongs.

This PR also doesn't split up any individual files, though it does sometimes move docs from directories to different places.

Rendered

gbrownmozilla commented 1 year ago

lgtm - thanks!

I think we should make a pass at updating links in all the places we can think of.

We should discuss the changelog; I'm leaning toward retiring it - I haven't found it very useful, and we haven't been keeping it up to date.

gabrielBusta commented 1 year ago

Some redirects that might be nice to have:

ahal commented 1 year ago

(fixed merge conflicts)