Commit abc863a5 authored by Natalia Tepluhina's avatar Natalia Tepluhina

Merge branch 'mjang-update-graphql-howto-edit-doc' into 'master'

Update howto update GraphQL doc schema

See merge request gitlab-org/gitlab!49270
parents 724cffdf 820e460b
...@@ -276,8 +276,13 @@ In its current state, the Rake task: ...@@ -276,8 +276,13 @@ In its current state, the Rake task:
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.
To edit the template used, please take a look at `lib/gitlab/graphql/docs/templates/default.md.haml`. To edit the content, you may need to edit the following:
The actual renderer is at `Gitlab::Graphql::Docs::Renderer`.
- The template. You can edit the template at `lib/gitlab/graphql/docs/templates/default.md.haml`.
The actual renderer is at `Gitlab::Graphql::Docs::Renderer`.
- The applicable `description` field in the code, which
[Updates machine-readable schema files](#update-machine-readable-schema-files),
which is then used by the `rake` task described earlier.
`@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 `Gitlab::Graphql::Docs::Helper` defines the `object` method we currently use. This is also where you
......
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