Conversation
Signed-off-by: Guillaume Lours <guillaume.lours@docker.com>
add docs validation (using same process a BuildX project) Signed-off-by: Guillaume Lours <guillaume.lours@docker.com>
Signed-off-by: Guillaume Lours <guillaume.lours@docker.com>
87fae73 to
572bd70
Compare
thaJeztah
reviewed
Mar 17, 2022
| shorthand: T | ||
| value_type: bool | ||
| default_value: "false" | ||
| default_value: "true" |
Member
There was a problem hiding this comment.
This looks odd; is this because we're detecting if we're running with a TTY attached? Perhaps there should be no visible default (or the description needs to be updated to reflect that we're automatically detecting)
Contributor
There was a problem hiding this comment.
+1 for documenting this in description
Contributor
Author
There was a problem hiding this comment.
Doc updated, thank you folks
Signed-off-by: Guillaume Lours <guillaume.lours@docker.com>
crazy-max
reviewed
Mar 17, 2022
Makefile
Outdated
| .PHONY: docs | ||
| docs: ## generate documentation | ||
| @docker build . \ | ||
| --output type=local,dest=./docs/ \ |
Member
There was a problem hiding this comment.
output will not rsync so if some files are not their anymore they will still be in the working tree. I suggest to do smth like https://github.com/docker/cli/blob/11c76f1ddbb64e4d88b44b48c017b81ffe86e0e5/docker.Makefile#L84-L88
Signed-off-by: Guillaume Lours <guillaume.lours@docker.com>
af7fdc1 to
ada0283
Compare
ndeloof
approved these changes
Mar 18, 2022
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
What I did
To be sure we're always in sync between the code and the reference documentation, we added in the Makefile:
(not mandatory) A picture of a cute animal, if possible in relation with what you did
