diff options
Diffstat (limited to 'doc/development/graphql_guide')
-rw-r--r-- | doc/development/graphql_guide/batchloader.md | 2 | ||||
-rw-r--r-- | doc/development/graphql_guide/graphql_pro.md | 21 | ||||
-rw-r--r-- | doc/development/graphql_guide/index.md | 7 | ||||
-rw-r--r-- | doc/development/graphql_guide/pagination.md | 4 |
4 files changed, 29 insertions, 5 deletions
diff --git a/doc/development/graphql_guide/batchloader.md b/doc/development/graphql_guide/batchloader.md index e965e678aba..1869c6e6f80 100644 --- a/doc/development/graphql_guide/batchloader.md +++ b/doc/development/graphql_guide/batchloader.md @@ -20,7 +20,7 @@ When implementing a new endpoint we should aim to minimise the number of SQL que Batch loading is useful when a series of queries for inputs `Qα, Qβ, ... Qω` can be combined to a single query for `Q[α, β, ... ω]`. An example of this is lookups by ID, where we can find two users by usernames as cheaply as one, but real-world examples can be more complex. -Batchloading is not suitable when the result sets have different sort-orders, grouping, aggregation or other non-composable features. +Batch loading is not suitable when the result sets have different sort-orders, grouping, aggregation or other non-composable features. There are two ways to use the batch-loader in your code. For simple ID lookups, use `::Gitlab::Graphql::Loaders::BatchModelLoader.new(model, id).find`. For more complex cases, you can use the batch API directly. diff --git a/doc/development/graphql_guide/graphql_pro.md b/doc/development/graphql_guide/graphql_pro.md new file mode 100644 index 00000000000..6f62d86af40 --- /dev/null +++ b/doc/development/graphql_guide/graphql_pro.md @@ -0,0 +1,21 @@ +--- +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/#assignments +--- + +# GraphQL Pro + +GraphQL has become a key technology in GitLab and is implemented using the +[GraphQL Ruby gem](https://graphql-ruby.org). As such, we've purchased a subscription to +[GraphQL Pro](https://graphql.pro). + +The main purpose is for support. Per the website: + +> As a GraphQL::Pro customer, you get direct access to the GraphQL Ruby gem +> creator and maintainer. Get prioritized support for issues and requests. + +Note that we **cannot** use the Pro version directly in our product, since we are +an Open Core product - we can not require customers to purchase the Pro version, nor can we ship it. + +Details on the billing account and gem licensing can be found in the Engineering 1Password vault. diff --git a/doc/development/graphql_guide/index.md b/doc/development/graphql_guide/index.md index 658bba96f33..fd6d8992f94 100644 --- a/doc/development/graphql_guide/index.md +++ b/doc/development/graphql_guide/index.md @@ -1,6 +1,6 @@ --- -stage: none -group: unassigned +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/#assignments --- @@ -17,3 +17,6 @@ feedback, and suggestions. - [GraphQL API documentation style guide](../documentation/graphql_styleguide.md): documentation style guide for GraphQL. - [GraphQL API](../../api/graphql/index.md): user documentation for the GitLab GraphQL API. +- [GraphQL BatchLoader](batchloader.md): development documentation on the batchloader. +- [GraphQL pagination](pagination.md): development documentation on pagination. +- [GraphQL Pro](graphql_pro.md): information on our GraphQL Pro subscription. diff --git a/doc/development/graphql_guide/pagination.md b/doc/development/graphql_guide/pagination.md index 130ed5721f3..55ff7942418 100644 --- a/doc/development/graphql_guide/pagination.md +++ b/doc/development/graphql_guide/pagination.md @@ -1,6 +1,6 @@ --- -stage: none -group: unassigned +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/#assignments --- |