build: incorporate build guide into manuals #20715
Conversation
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
github-actions
bot
added
area/build
The build guide that I once wrote now duplicates a lot of content with the concept guide launched a few months back. It doesn't make sense to cover the same topics multiple times, so I'm removing the older build guide and incorporating some of the topics into the build manual instead. Signed-off-by: David Karlsson <[email protected]>
dvdksn
force-pushed
the
build-guide-refactor
branch
from
fa5cd87 to
df6367f
Compare
|
Love seeing the de-duplication work on this. It helps the user experience a bunch. Haven't finished by any means but here are a few notes
|
|
Thanks @thompson-shaun
Yeah, with this change I am also moving away from the tutorial-style sequence of things, where we expected users to go from A, B, C, etc. Here we're describing each of the capabilities in a more standalone way instead. Which is also why e.g. the Dockerfile examples are most of the time using something like a git context as well, as opposed to assuming that any local files exist. Just so that they can be "stateless". I did try to make sure that we have the prerequisites for each thing listed out, e.g. containerd for multi-platform, but let me know if something seems off or missing. I will have another look. |
|
I like the play tbh, it avoids drift between those sections. Other alternatives that come to mind: If we could link to a single source of truth or offer a nudge to "check your setup". Either way I like the new setup 😄 |
The build guide that I once wrote now duplicates a lot of content with
the concept guide launched a few months back. It doesn't make sense to
cover the same topics multiple times, so I'm removing the older build
guide and incorporating some of the topics into the build manual
instead.
Signed-off-by: David Karlsson [email protected]
New/revised content: