Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
820e460b
Commit
820e460b
authored
Dec 07, 2020
by
Mike Jang
Committed by
Natalia Tepluhina
Dec 07, 2020
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update howto update GraphQL doc schema
parent
f979f658
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
7 additions
and
2 deletions
+7
-2
doc/development/rake_tasks.md
doc/development/rake_tasks.md
+7
-2
No files found.
doc/development/rake_tasks.md
View file @
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
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment