Conversation
/cc @bermudezmt |
ping @chris-crone @silvin-lubecki PTAL; this is green now |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm what is this docs/reference/.keep
file? 🤔
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thank you @thaJeztah for handling that 😍
Indeed we need some factorization with docker/cli on this code, but this can be done in a followup 👍
Right, so Git only stores files, not directories; the generator expects a directory containing Markdown files for the extended descriptions, which we currently don't have; we can remove that |
@usha-mandya as we've discussed previously, the extended descriptions and examples (when we have them) should live in the |
Codecov Report
@@ Coverage Diff @@
## master #533 +/- ##
==========================================
- Coverage 71.44% 71.02% -0.42%
==========================================
Files 59 59
Lines 3029 2989 -40
==========================================
- Hits 2164 2123 -41
+ Misses 583 582 -1
- Partials 282 284 +2
Continue to review full report at Codecov.
|
This is a very quick 'n dirty implementation of the YAML docs generation; copied from the docker/cli repository with some minor modifications and a new Makefile target. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks @thaJeztah !
This is a very quick 'n dirty implementation of the YAML docs generation;
copied from the docker/cli repository with some minor modifications and a
new Makefile target.
I'll open a PR in the documentation repository to verify if the output all works (similar to docker/docs#8759); we should also
Example of the generated YAML files;
yamldocs.zip