Skip to content
This repository has been archived by the owner on Jun 13, 2021. It is now read-only.

Add YAML-docs generation #533

Merged
merged 1 commit into from Oct 24, 2019
Merged

Add YAML-docs generation #533

merged 1 commit into from Oct 24, 2019

Conversation

thaJeztah
Copy link
Member

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

  • have a look at making the generating code generic enough so that we can just vendor it (instead of copying)
  • have a way to automate the yaml files in the documentation repository (perhaps be by pushing the docker image to hub)?

Example of the generated YAML files;

yamldocs.zip

@thaJeztah
Copy link
Member Author

/cc @bermudezmt

@thaJeztah
Copy link
Member Author

ping @chris-crone @silvin-lubecki PTAL; this is green now

Copy link
Contributor

@silvin-lubecki silvin-lubecki left a 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? 🤔

Copy link
Contributor

@silvin-lubecki silvin-lubecki left a 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 👍

@thaJeztah
Copy link
Member Author

Hmm what is this docs/reference/.keep file? 🤔

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 .keep file once there's some Markdown files in the directory

@bermudezmt
Copy link

@usha-mandya as we've discussed previously, the extended descriptions and examples (when we have them) should live in the reference folder. @silvin-lubecki this is an example Markdown addition from @thaJeztah : https://github.com/docker/registry-cli/pull/47/files 👋

@codecov
Copy link

codecov bot commented Aug 30, 2019

Codecov Report

Merging #533 into master will decrease coverage by 0.41%.
The diff coverage is n/a.

Impacted file tree graph

@@            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
Impacted Files Coverage Δ
types/parameters/parameters.go 92.06% <0%> (-4.77%) ⬇️
internal/commands/image/list.go 83.33% <0%> (-4.17%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 433639b...f49d335. Read the comment docs.

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>
Copy link
Member

@chris-crone chris-crone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks @thaJeztah !

@ndeloof ndeloof merged commit e5b6e29 into docker:master Oct 24, 2019
@thaJeztah thaJeztah deleted the yamldocs branch October 24, 2019 15:17
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants