[DOCS] Simplify grammar and diagrams generation for API docs #2069
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Can one of the admins verify this patch? |
|
|
stevebang
reviewed
Aug 15, 2019
stevebang
reviewed
Aug 15, 2019
stevebang
reviewed
Aug 15, 2019
stevebang
reviewed
Aug 15, 2019
stevebang
reviewed
Aug 15, 2019
stevebang
reviewed
Aug 15, 2019
stevebang
reviewed
Aug 15, 2019
stevebang
reviewed
Aug 15, 2019
stevebang
reviewed
Aug 15, 2019
stevebang
reviewed
Aug 15, 2019
stevebang
reviewed
Aug 15, 2019
stevebang
reviewed
Aug 15, 2019
stevebang
reviewed
Aug 15, 2019
stevebang
reviewed
Aug 15, 2019
stevebang
reviewed
Aug 15, 2019
stevebang
suggested changes
Aug 15, 2019
m-iancu
force-pushed
the
docs_gram
branch
4 times, most recently
from
2ad521b to
2bc5ec3
Compare
Summary: Grammar and diagrams for API docs can now be generated automatically by running a script. Also they are now shown in tabs (as alternative representations of the syntax) rather than on after the other. The docs Readme is updated with instructions on how to edit/update the docs with this new set-up. The YSQL docs are updated to use the new framework, the YCQL ones are not yet changed. Also a few other minor fixes in the YSQL docs. Test Plan: None Reviewers: karthik, sid, steve, neha Subscribers: yql
|
How it should look: Grammar Tab (Default):
Diagram Tab:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Grammar and diagrams for API docs can now be generated automatically by running a script.
Also they are now shown in tabs (as alternative representations of the syntax) rather
than on after the other.
The docs Readme is updated with instructions on how to edit/update the docs with
this new set-up.
The YSQL docs are updated to use the new framework, the YCQL ones are not yet changed.
Also a few other minor fixes in the YSQL docs.