#387 Reorganize Release Engineering docs structure
Merged by patrikp. Opened by patrikp.
patrikp/infra-docs-fpo sop_updates  into  master

Download 387.patch

Documentation updates are looking good!

So, overall looks pretty nice... a few things:

  • There's a few places in philosophy were we say to only use koji... but... thats not entirely true anymore, we have fedora coreos with their own build pipeline and iot that does their own composes.
    We may be able to just soften the wording there?

  • The layered_image_build_service workflow_automation doesn't seem to be attached?
    Is there a image there?

This PR is a great step forward—it’ll make our docs easier to follow, more accurate, and better aligned with actual Fedora releng practices as they evolve. Modernizing the navigation and terminology pays off in lower maintenance and better onboarding for future contributors.

I see the main changes in the PR are making changes to the philosophy doc, and the untretirement changes, so I reviewed them, other seems to be a cosmetic move (thanks for the structure)

There's a few places in philosophy were we say to only use koji... but... thats not entirely true anymore, we have fedora coreos with their own build pipeline and iot that does their own composes. We may be able to just soften the wording there?

As kevin mentioned, fedora-coreos, iot composes etc, have there own ways to mentioning and acknowedging there work will help, and for the other component please check for the image.

Cosmetic feedbacks (can be ignored):

  • Sometimes technical terms use backticks (like releng, Open, Integrated) and sometimes they don't in the past, so make sure it's consistent, if it is then it's great.
  • Minor typos (after reading): s/evergrowing/ever-growing/g``s/different otions/different options/g
  • "There is no need to reproduce software we do not have to ship" feels awkward - maybe "No need to reproduce software we don't ship"

Otherwise, looks good!

rebased onto 58e0c076d8b51819a30ed903523d7b9ea28bcd36

Pull-Request has been merged by patrikp

Metadata