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.

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

Merged
merged 9 commits into from
Jun 4, 2019

Conversation

pavolloffay
Copy link
Member

@pavolloffay pavolloffay commented May 29, 2019

Resolves #1537

docs PR: jaegertracing/documentation#257

Signed-off-by: Pavol Loffay ploffay@redhat.com

@codecov
Copy link

codecov bot commented May 29, 2019

Codecov Report

Merging #1572 into master will increase coverage by <.01%.
The diff coverage is 100%.

Impacted file tree graph

@@            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
Impacted Files Coverage Δ
cmd/docs/command.go 100% <100%> (ø)

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 114c19a...4c8c385. Read the comment docs.

cmd/docs/command.go Outdated Show resolved Hide resolved
cmd/docs/docs.md Outdated Show resolved Hide resolved
yurishkuro
yurishkuro previously approved these changes May 29, 2019
Copy link
Member

@yurishkuro yurishkuro left a comment

Choose a reason for hiding this comment

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

lgtm

Gopkg.toml Show resolved Hide resolved
Gopkg.toml Show resolved Hide resolved
cmd/all-in-one/main.go Outdated Show resolved Hide resolved
@yurishkuro yurishkuro dismissed their stale review May 29, 2019 18:45

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.

@pavolloffay
Copy link
Member Author

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.

@pavolloffay
Copy link
Member Author

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.

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>
cmd/docs/command.go Outdated Show resolved Hide resolved
cmd/docs/command.go Outdated Show resolved Hide resolved
Signed-off-by: Pavol Loffay <ploffay@redhat.com>
Signed-off-by: Pavol Loffay <ploffay@redhat.com>
@pavolloffay
Copy link
Member Author

@yurishkuro one last thing. Do we like more jaeger docs or jaeger gen docs. The later is more flexible if we add more gen commands (e.g. auto-completion).

cmd/agent/main.go Outdated Show resolved Hide resolved
Signed-off-by: Pavol Loffay <ploffay@redhat.com>
cmd/docs/command.go Outdated Show resolved Hide resolved
cmd/docs/command.go Show resolved Hide resolved
Signed-off-by: Pavol Loffay <ploffay@redhat.com>
Signed-off-by: Pavol Loffay <ploffay@redhat.com>
Signed-off-by: Pavol Loffay <ploffay@redhat.com>
Signed-off-by: Pavol Loffay <ploffay@redhat.com>
Signed-off-by: Pavol Loffay <ploffay@redhat.com>
@pavolloffay pavolloffay merged commit d994244 into jaegertracing:master Jun 4, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Generate flags documentation
2 participants