[Docs] Automatic Graphql Docs Generation #2989
Merged
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
|
Deploy Preview for meshery-docs ready! Built with commit b1326d8 |
Signed-off-by: dhruv0000 <[email protected]>
|
Watch the generated GraphQL docs at https://deploy-preview-2989--meshery-docs.netlify.app/extensibility/graphql-reference |
dhruv0000
changed the title
|
This is a great looking docs preview. |
leecalcote
added
component/api
Signed-off-by: dhruv0000 <[email protected]>
Signed-off-by: dhruv0000 <[email protected]>
Signed-off-by: dhruv0000 <[email protected]>
leecalcote
reviewed
May 23, 2021
| @@ -1,6 +1,55 @@ | |||
| GEM | |||
| remote: https://rubygems.org/ | |||
| specs: | |||
| actioncable (6.0.3.7) | |||
There was a problem hiding this comment.
I hope GitHub Pages supports these. 🤞
|
A review on the GraphQL comments in |
Signed-off-by: dhruv0000 <[email protected]>
|
@dhruv0000 remove |
Signed-off-by: dhruv0000 <[email protected]>
Signed-off-by: dhruv0000 <[email protected]>
|
Ready for a Merge @abhishekkumkar 👍 |
leecalcote
approved these changes
May 24, 2021
There was a problem hiding this comment.
Let's see how GH Pages does with this...
Thank you, @dhruv0000!
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.
Signed-off-by: dhruv0000 [email protected]
Description
This PR automatically generates GraphQL docs based on the schema in
internal/graphql/schema/schema.graphqland creates an custom.mdpage which the Jekyll Site can refer to.Generate Docs using
make install bundle exec rake graphql:compile_docsWatch the generated docs at
extensibility/graphql-referenceendpoint. (temporary)DONE:
schema.graphqlThis PR fixes #
Notes for Reviewers
Signed commits