-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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.
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
Add docs generation command #1572
Add docs generation command #1572
Conversation
Codecov Report
@@ Coverage Diff @@
## master #1572 +/- ##
=========================================
+ Coverage 98.79% 98.8% +<.01%
=========================================
Files 190 191 +1
Lines 9063 9102 +39
=========================================
+ Hits 8954 8993 +39
Misses 85 85
Partials 24 24
Continue to review full report at Codecov.
|
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
actually, I don't think pre-formatted output in .md file is the best format. I see that blackfriday supports HTML output, not sure if it makes a different and/or of cobra can generate HTML.
Cobra can also output html and man pages. We could even make it configurable via a flag. Most importantly we should go with a format which can be embedded to our docs. I am not sure if we can easily embed there htlm. The markdown can be easily embedded see the PR to the website. |
actually cobra cannot generate html, I have added a flag to generate output in md, rst and man format. |
Signed-off-by: Pavol Loffay <ploffay@redhat.com>
c4a2b1f
to
281b356
Compare
Signed-off-by: Pavol Loffay <ploffay@redhat.com>
Signed-off-by: Pavol Loffay <ploffay@redhat.com>
@yurishkuro one last thing. Do we like more |
Resolves #1537
docs PR: jaegertracing/documentation#257
Signed-off-by: Pavol Loffay ploffay@redhat.com