Commit 623a3db3 authored by Russell Dickenson's avatar Russell Dickenson

Merge branch 'eread/edit-graphql-raketasks-doc' into 'master'

Minor fixes to new rake tasks content

See merge request gitlab-org/gitlab!18621
parents 3ca122fb 75405677
...@@ -232,7 +232,7 @@ bundle exec rake gitlab:graphql:compile_docs ...@@ -232,7 +232,7 @@ bundle exec rake gitlab:graphql:compile_docs
In its current state, the rake task: In its current state, the rake task:
- Generates output for GraphQL objects. - Generates output for GraphQL objects.
- Places the output at `docs/api/graphql/reference/index.md`. - Places the output at `doc/api/graphql/reference/index.md`.
This uses some features from `graphql-docs` gem like its schema parser and helper methods. This uses some features from `graphql-docs` gem like its schema parser and helper methods.
The docs generator code comes from our side giving us more flexibility, like using Haml templates and generating Markdown files. The docs generator code comes from our side giving us more flexibility, like using Haml templates and generating Markdown files.
...@@ -241,5 +241,5 @@ To edit the template used, please take a look at `lib/gitlab/graphql/docs/templa ...@@ -241,5 +241,5 @@ To edit the template used, please take a look at `lib/gitlab/graphql/docs/templa
The actual renderer is at `Gitlab::Graphql::Docs::Renderer`. The actual renderer is at `Gitlab::Graphql::Docs::Renderer`.
`@parsed_schema` is an instance variable that the `graphql-docs` gem expects to have available. `@parsed_schema` is an instance variable that the `graphql-docs` gem expects to have available.
`Gitlab::Graphql::Docs::Helper` defines the `object` method we currently use. This is also where you should implement any `Gitlab::Graphql::Docs::Helper` defines the `object` method we currently use. This is also where you
new methods for new types you'd like to display. should implement any new methods for new types you'd like to display.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment