DOC GraphQL schema init task

silverstripe · Apr 10, 2024 · 68de344 · 68de344
1 parent eae39d5
commit 68de344
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/en/02_Developer_Guides/19_GraphQL/01_getting_started/02_configuring_your_schema.md b/en/02_Developer_Guides/19_GraphQL/01_getting_started/02_configuring_your_schema.md
@@ -24,6 +24,9 @@ There's a bit more to it than that, and if you want to learn more about GraphQL,
 the [full documentation](https://graphql.org/learn/), but for now, these three concepts will
 serve almost all of your needs to get started.
 
+> [!TIP]
+> You may wish to install [silverstripe/graphql-devools](https://github.com/silverstripe/silverstripe-graphql-devtools) which includes a `GraphQLSchemaInitTask` task to initialise a basic GraphQL schema to get you started. Instructions for using that task are included in that modules README.md.
+
 ### Initial setup
 
 To start your first schema, open a new configuration file. Let's call it `graphql.yml`.

diff --git a/en/08_Changelogs/5.3.0.md b/en/08_Changelogs/5.3.0.md
@@ -8,6 +8,7 @@ title: 5.3.0 (unreleased)
 
 - [Features and enhancements](#features-and-enhancements)
   - [Support for `JOIN` in SQL `UPDATE`](#sql-update-join)
+  - [GraphQL schema initialise task](#graphql-schema-task)
 - [Bug fixes](#bug-fixes)
 
 ## Features and enhancements
@@ -18,6 +19,10 @@ The [`SQLUpdate`](api:SilverStripe\ORM\Queries\SQLUpdate) class now supports all
 
 This is particularly helpful if you need to update columns in one table to match values from another table.
 
+### GraphQL schema initialise task {#graphql-schema-task}
+
+There is a new task to help you initialise a basic GraphQL schema. The `GraphQLSchemaInitTask` will create configuration files for your schema and a basic resolver. This task is provided in the `silverstripe/graphql-devtools` module.
+
 ## Bug fixes
 
 This release includes a number of bug fixes to improve a broad range of areas. Check the change logs for full details of these fixes split by module. Thank you to the community members that helped contribute these fixes as part of the release!