Enhanced developer documentation #3013
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
crazy-max
reviewed
Aug 9, 2022
|
@coryb could you also confirm you'd be happy to be added as a co-author on the relevant import commits? @hinshun is there a particular email address you'd like? In the buildkit history I see |
|
@jedevc Please use |
tonistiigi
reviewed
Aug 12, 2022
Signed-off-by: Justin Chadwell <[email protected]>
Signed-off-by: Justin Chadwell <[email protected]>
Co-authored-by: Edgar Lee <[email protected]> Co-authored-by: coryb <[email protected]> Signed-off-by: Justin Chadwell <[email protected]>
Co-authored-by: Edgar Lee <[email protected]> Co-authored-by: coryb <[email protected]> Signed-off-by: Justin Chadwell <[email protected]>
Signed-off-by: Justin Chadwell <[email protected]>
Signed-off-by: Justin Chadwell <[email protected]>
Signed-off-by: Justin Chadwell <[email protected]>
crazy-max
approved these changes
Aug 18, 2022
tonistiigi
approved these changes
Sep 2, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR attempts to rework some of the existing developer documentation, while adding some additional pages.
The driving idea behind this is to have a central location in
./docs/devwhere potential buildkit contributors and integrators can read and learn about the internal mechanisms without needing to dive into the code for all of the details. Ideally, we'd work to build this out over time even more, especially around areas that are especially complex, are areas that we expect developers to integrate with, such as attestations, frontends, etc.@hinshun, @tonistiigi tells me you're the original author of the "Buildkit developer guide" google doc that I've taken the content for the
request-lifecycle.mdanddockerfile-llb.mdpages from (though I've changed some of the examples to be more up-to-date). I'd like to add you as a co-author to those commits, could you confirm if you're happy with that?