Skip to content

Extract yaml used in documentation into files#1593

Merged
dgageot merged 1 commit intoGoogleContainerTools:masterfrom
dgageot:extract-yamls
Feb 4, 2019
Merged

Extract yaml used in documentation into files#1593
dgageot merged 1 commit intoGoogleContainerTools:masterfrom
dgageot:extract-yamls

Conversation

@dgageot
Copy link
Copy Markdown
Contributor

@dgageot dgageot commented Feb 4, 2019

This creates a shortcode to embed yaml configuration fragments into the documentation.
The fragments are parsed by a unit test to ensure that each of them is a valid configuration.

This helped fix a bug in one of the yaml files.

Signed-off-by: David Gageot david@gageot.net

Signed-off-by: David Gageot <david@gageot.net>
@codecov-io
Copy link
Copy Markdown

Codecov Report

Merging #1593 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1593   +/-   ##
=======================================
  Coverage   46.51%   46.51%           
=======================================
  Files         118      118           
  Lines        5044     5044           
=======================================
  Hits         2346     2346           
  Misses       2464     2464           
  Partials      234      234

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 f5dbcb3...b9073a0. Read the comment docs.

Copy link
Copy Markdown
Contributor

@balopat balopat 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, this is awesome!
The only tiny nit I have that as it is the readFile shortcode always adds a yaml syntaxed code.
We could rename it to includeYaml or maybe we can parametrize the language and add the yaml tag on readFile as a parameter...

@dgageot
Copy link
Copy Markdown
Contributor Author

dgageot commented Feb 4, 2019

@balopat Thanks! I'll add type argument when it's needed

@dgageot dgageot merged commit 6437d83 into GoogleContainerTools:master Feb 4, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants