diff options
Diffstat (limited to 'lib/gitlab/graphql/docs')
| -rw-r--r-- | lib/gitlab/graphql/docs/helper.rb | 6 | ||||
| -rw-r--r-- | lib/gitlab/graphql/docs/templates/default.md.haml | 4 |
2 files changed, 8 insertions, 2 deletions
diff --git a/lib/gitlab/graphql/docs/helper.rb b/lib/gitlab/graphql/docs/helper.rb index 503b1064b11..ad9e08e189c 100644 --- a/lib/gitlab/graphql/docs/helper.rb +++ b/lib/gitlab/graphql/docs/helper.rb @@ -13,6 +13,12 @@ module Gitlab def auto_generated_comment <<-MD.strip_heredoc + --- + stage: Plan + group: Project Management + info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers + --- + <!--- This documentation is auto generated by a script. diff --git a/lib/gitlab/graphql/docs/templates/default.md.haml b/lib/gitlab/graphql/docs/templates/default.md.haml index 97df4233905..8f5a1788fa5 100644 --- a/lib/gitlab/graphql/docs/templates/default.md.haml +++ b/lib/gitlab/graphql/docs/templates/default.md.haml @@ -12,7 +12,7 @@ Each table below documents a GraphQL type. Types match loosely to models, but not all fields and methods on a model are available via GraphQL. - CAUTION: **Caution:** + WARNING: Fields that are deprecated are marked with **{warning-solid}**. Items (fields, enums, etc) that have been removed according to our [deprecation process](../index.md#deprecation-process) can be found in [Removed Items](../removed_items.md). @@ -21,7 +21,7 @@ :plain ## Object types - Object types represent the resources that GitLab's GraphQL API can return. + Object types represent the resources that the GitLab GraphQL API can return. They contain _fields_. Each field has its own type, which will either be one of the basic GraphQL [scalar types](https://graphql.org/learn/schema/#scalar-types) (e.g.: `String` or `Boolean`) or other object types. |