Skip to content

Update build documentation

John Skarbek requested to merge jts/improve-documentation into master

What does this MR do?

  • Improve the colors on the chart, while I applaud the use of GitLab colors, it is not friendly to color blind
    • The chosen color scheme is a random one that popped up when searching for something color blind friendly
    • While I'm here, I added borders to all boxes to provide further assistance
  • Remove the 'rule of thumb' in favor of something more concrete - I chose to leverage an explicit call out that should be placed in all final images
    • I saw the use of Final image in 2 Dockerfiles, so I leveraged this that way one can easily grep 'FINAL IMAGE' across the entire repo
    • Perhaps in the future we can leverage something like this that helps build documentation automagically
  • Update the stage listing with the current state
  • Removes the version numbering from our documentation - this should reduce documentation from going out-of-date
  • Moves a chunk of UBI offline related docs up to that explicit section - I presume this was accidentally moved in the past
  • Fixes dead link in the variables documentation

Related issues

Addresses:

Checklist

See Definition of done.

For anything in this list which will not be completed, please provide a reason in the MR discussion

Required

  • Merge Request Title, and Description are up to date, accurate, and descriptive
  • MR targeting the appropriate branch
  • MR has a green pipeline on GitLab.com

Expected (please provide an explanation if not completing)

  • Test plan indicating conditions for success has been posted and passes - n/a - no changes to actual images
  • Documentation created/updated
  • Integration tests added to GitLab QA - n/a - no changes to actual images
  • The impact any change in container size has should be evaluated - n/a - no changes to actual images
Edited by John Skarbek

Merge request reports