Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve documentation #1713

Merged
merged 7 commits into from
Mar 1, 2019
Merged

Improve documentation #1713

merged 7 commits into from
Mar 1, 2019

Conversation

dgageot
Copy link
Contributor

@dgageot dgageot commented Mar 1, 2019

  • Check the existence of valid comments on the config Go structs
  • Simplify the code that generates the documentation
  • Some shorter descriptions
  • Better rendering of alpha/beta fields

dgageot added 7 commits March 1, 2019 09:38
@dgageot
Check for empty descriptions on the latest schema
393a289 
Also ignore non marshalled fields

Signed-off-by: David Gageot <david@gageot.net>
@dgageot
Simplify code
4996307
@dgageot
Add some more validation
df30c04 
Signed-off-by: David Gageot <david@gageot.net>
@dgageot
Cleanup annotated yaml generation code
3e6ddca
@dgageot
Improve rendering of alpha/beta
1482374 
Signed-off-by: David Gageot <david@gageot.net>
@dgageot
Remove EOL from html descriptions
5daf0dc 
Signed-off-by: David Gageot <david@gageot.net>
@dgageot
Shorter descriptions
b2a6741 
Signed-off-by: David Gageot <david@gageot.net>
@codecov-io
Copy link

codecov-io commented Mar 1, 2019 •
edited
Loading

Codecov Report

Merging #1713 into master will decrease coverage by 0.05%.
The diff coverage is 76%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1713      +/-   ##
==========================================
- Coverage   47.05%   46.99%   -0.06%     
==========================================
  Files         126      126              
  Lines        6142     6147       +5     
==========================================
- Hits         2890     2889       -1     
- Misses       2961     2964       +3     
- Partials      291      294       +3
Impacted Files Coverage Δ
pkg/skaffold/schema/v1beta5/config.go 100% <ø> (ø) ⬆️
hack/schemas/main.go 87% <76%> (-3.12%) ⬇️

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 bd485f6...b2a6741. Read the comment docs.

@balopat balopat added the docs-modifications runs the docs preview service on the given PR label Mar 1, 2019
@container-tools-bot
Copy link

Please visit http://35.236.109.79:1313 to view changes to the docs.

@container-tools-bot container-tools-bot removed the docs-modifications runs the docs preview service on the given PR label Mar 1, 2019
balopat
balopat approved these changes Mar 1, 2019
View reviewed changes
Copy link
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.

Thank you, looks great!

@dgageot dgageot merged commit 9fb60c4 into GoogleContainerTools:master Mar 1, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@balopat balopat balopat approved these changes

@nkubala nkubala Awaiting requested review from nkubala

@priyawadhwa priyawadhwa Awaiting requested review from priyawadhwa

@r2d4 r2d4 Awaiting requested review from r2d4

Assignees
No one assigned
Labels
cla: yes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@dgageot @codecov-io @container-tools-bot @balopat @googlebot