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

parse thrift into markdown or something #21

Closed
codefromthecrypt opened this issue Oct 5, 2016 · 4 comments
Closed

parse thrift into markdown or something #21

codefromthecrypt opened this issue Oct 5, 2016 · 4 comments

Comments

@codefromthecrypt
Copy link
Member

our most authoritative description of fields and nuance is the thrift. Is there some way we can parse it into markdown or something so that there's a human readable copy on zipkin.io?

ex.
https://github.com/openzipkin/zipkin-api/blob/master/thrift/zipkinCore.thrift#L272

cc @abesto @basvanbeek
codefromthecrypt pushed a commit to openzipkin/openzipkin.github.io that referenced this issue Oct 5, 2016
@adriancole
Add link to data structure details
24b98a0 
Often it is the case that people ask questions we already have answers to. For starters, let's make the thrift doc known!

See openzipkin/zipkin-api#21
@codefromthecrypt codefromthecrypt mentioned this issue Oct 5, 2016
Merged
@codefromthecrypt
Copy link
Member Author

offline chat with @basvanbeek maybe we can compile to java, then java to markdown

https://delight-im.github.io/Javadoc-to-Markdown/

@abesto
Copy link
Member

abesto commented Oct 9, 2016 •
edited
Loading

Or maybe even write a Thrift-Markdown compiler! Adding to my todo list, no commitment for now.

codefromthecrypt pushed a commit to openzipkin/openzipkin.github.io that referenced this issue Oct 11, 2016
@adriancole
Add link to data structure details (#55)
6b5c5cf 
Often it is the case that people ask questions we already have answers to. For starters, let's make the thrift doc known!

See openzipkin/zipkin-api#21
@abesto abesto mentioned this issue Jan 28, 2018
Merged
@abesto
Copy link
Member

abesto commented Jan 28, 2018

Soo... this is somewhat embarrassing, but it turns out Thrift has (and has, for pretty much forever had) an HTML generator. Just opened a PR in openzipkin.github.io using it.

@abesto
Copy link
Member

abesto commented Jan 31, 2018

Closing as fixed with openzipkin/openzipkin.github.io#98, reopen if I missed something.

@abesto abesto closed this as completed Jan 31, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@abesto @codefromthecrypt