remove h2 from index.adoc

Author: rwinch

spring-graphql-docs/modules/ROOT/nav.adoc

@@ -1,10 +1,13 @@
-* xref:index.adoc[]
-** xref:includes/transports.adoc[]
-** xref:includes/request-execution.adoc[]
-** xref:includes/data.adoc[]
-** xref:includes/controllers.adoc[]
-** xref:includes/observability.adoc[]
-** xref:includes/graalvm-native.adoc[]
-** xref:includes/client.adoc[]
-** xref:includes/graphiql.adoc[]
-** xref:includes/testing.adoc[]
+* xref:index.adoc[Overview]
+* xref:transports.adoc[]
+* xref:request-execution.adoc[]
+* xref:data.adoc[]
+* xref:controllers.adoc[]
+* xref:security.adoc[]
+* xref:observability.adoc[]
+* xref:graalvm-native.adoc[]
+* xref:client.adoc[]
+* xref:graphiql.adoc[]
+* xref:testing.adoc[]
+* xref:boot-starter.adoc[]
+* xref:samples.adoc[]

spring-graphql-docs/modules/ROOT/pages/boot-starter.adoc

@@ -0,0 +1,21 @@
+[[boot-starter]]
+= Boot Starter
+
+Spring Boot provides a starter for building GraphQL applications with Spring for GraphQL.
+For version information, see the
+https://github.com/spring-projects/spring-graphql/wiki/Spring-for-GraphQL-Versions[Spring for GraphQL Versions] wiki page.
+
+The easiest way to get started is via https://start.spring.io by selecting
+"Spring for GraphQL" along with an underlying transport such as Spring MVC of WebFlux over
+HTTP or WebSocket, or over RSocket. Refer to the
+https://docs.spring.io/spring-boot/docs/current/reference/html/web.html#web.graphql[Spring for GraphQL Starter]
+section in the Spring Boot reference for details on supported transports, auto-configuration related
+features, and more. For testing support, see
+https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#features.testing.spring-boot-applications.spring-graphql-tests[Auto-Configured GraphQL Tests].
+
+For further reference, check the following GraphQL related:
+
+- https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html#actuator.metrics.supported.spring-graphql[Metrics]
+- https://docs.spring.io/spring-boot/docs/current/reference/html/application-properties.html#appendix.application-properties.web[Properties]
+- https://docs.spring.io/spring-boot/docs/current/reference/html/auto-configuration-classes.html#appendix.auto-configuration-classes.core[Auto-Configuration Classes]
+

spring-graphql-docs/modules/ROOT/pages/includes/client.adoc renamed to spring-graphql-docs/modules/ROOT/pages/client.adoc

@@ -16,15 +16,15 @@ build time.
 
 To create a `GraphQlClient` you need one of the following extensions:
 
-- xref:includes/client.adoc#client.httpgraphqlclient[HttpGraphQlClient]
-- xref:includes/client.adoc#client.websocketgraphqlclient[WebSocketGraphQlClient]
-- xref:includes/client.adoc#client.rsocketgraphqlclient[RSocketGraphQlClient]
+- xref:client.adoc#client.httpgraphqlclient[HttpGraphQlClient]
+- xref:client.adoc#client.websocketgraphqlclient[WebSocketGraphQlClient]
+- xref:client.adoc#client.rsocketgraphqlclient[RSocketGraphQlClient]
 
 Each defines a `Builder` with options relevant to the transport. All builders extend
-from a common, base GraphQlClient xref:includes/client.adoc#client.graphqlclient.builder[`Builder`] with options
+from a common, base GraphQlClient xref:client.adoc#client.graphqlclient.builder[`Builder`] with options
 relevant to all extensions.
 
-Once you have a `GraphQlClient` you can begin to make xref:includes/client.adoc#client.requests[requests].
+Once you have a `GraphQlClient` you can begin to make xref:client.adoc#client.requests[requests].
 
 
 [[client.httpgraphqlclient]]
@@ -41,7 +41,7 @@ HttpGraphQlClient graphQlClient = HttpGraphQlClient.create(webClient);
 ----
 
 Once `HttpGraphQlClient` is created, you can begin to
-xref:includes/client.adoc#client.requests[execute requests] using the same API, independent of the underlying
+xref:client.adoc#client.requests[execute requests] using the same API, independent of the underlying
 transport. If you need to change any transport specific details, use `mutate()` on an
 existing `HttpGraphQlClient` to create a new instance with customized settings:
 
@@ -97,7 +97,7 @@ single, shared connection for all requests to that server. Each client instance
 establishes its own connection and that is typically not the intent for a single server.
 
 Once `WebSocketGraphQlClient` is created, you can begin to
-xref:includes/client.adoc#client.requests[execute requests] using the same API, independent of the underlying
+xref:client.adoc#client.requests[execute requests] using the same API, independent of the underlying
 transport. If you need to change any transport specific details, use `mutate()` on an
 existing `WebSocketGraphQlClient` to create a new instance with customized settings:
 
@@ -149,7 +149,7 @@ For WebSocket transport specific interception, you can create a
 	}
 ----
 
-xref:includes/client.adoc#client.interception[Register] the above interceptor as any other
+xref:client.adoc#client.interception[Register] the above interceptor as any other
 `GraphQlClientInterceptor` and use it also to intercept GraphQL requests, but note there
 can be at most one interceptor of type `WebSocketGraphQlClientInterceptor`.
 
@@ -187,7 +187,7 @@ single, shared session for all requests to that server. Each client instance
 establishes its own connection and that is typically not the intent for a single server.
 
 Once `RSocketGraphQlClient` is created, you can begin to
-xref:includes/client.adoc#client.requests[execute requests] using the same API, independent of the underlying
+xref:client.adoc#client.requests[execute requests] using the same API, independent of the underlying
 transport.
 
 
@@ -199,16 +199,16 @@ transport.
 builders of all extensions. Currently, it has lets you configure:
 
 - `DocumentSource` strategy to load the document for a request from a file
-- xref:includes/client.adoc#client.interception[Interception] of executed requests
+- xref:client.adoc#client.interception[Interception] of executed requests
 
 
 
 
 [[client.requests]]
 == Requests
 
-Once you have a xref:includes/client.adoc#client.graphqlclient[`GraphQlClient`], you can begin to perform requests via
-xref:includes/client.adoc#client.requests.retrieve[retrieve()] or xref:includes/client.adoc#client.requests.execute[execute()]
+Once you have a xref:client.adoc#client.graphqlclient[`GraphQlClient`], you can begin to perform requests via
+xref:client.adoc#client.requests.retrieve[retrieve()] or xref:client.adoc#client.requests.execute[execute()]
 where the former is only a shortcut for the latter.
 
 
@@ -239,7 +239,7 @@ The below retrieves and decodes the data for a query:
 
 The input document is a `String` that could be a literal or produced through a code
 generated request object. You can also define documents in files and use a
-xref:includes/client.adoc#client.requests.document-source[Document Source] to resole them by file name.
+xref:client.adoc#client.requests.document-source[Document Source] to resole them by file name.
 
 The path is relative to the "data" key and uses a simple dot (".") separated notation
 for nested fields with optional array indices for list elements, e.g. `"project.name"`
@@ -267,7 +267,7 @@ response and the field:
 [[client.requests.execute]]
 === Execute
 
-xref:includes/client.adoc#client.requests.retrieve[Retrieve] is only a shortcut to decode from a single path in the
+xref:client.adoc#client.requests.retrieve[Retrieve] is only a shortcut to decode from a single path in the
 response map. For more control, use the `execute` method and handle the response:
 
 For example:
@@ -341,7 +341,7 @@ You can then:
 
 The "JS GraphQL" plugin for IntelliJ supports GraphQL query files with code completion.
 
-You can use the `GraphQlClient` xref:includes/client.adoc#client.graphqlclient.builder[Builder] to customize the
+You can use the `GraphQlClient` xref:client.adoc#client.graphqlclient.builder[Builder] to customize the
 `DocumentSource` for loading documents by names.
 
 
@@ -352,16 +352,16 @@ You can use the `GraphQlClient` xref:includes/client.adoc#client.graphqlclient.b
 
 `GraphQlClient` can execute subscriptions over transports that support it. Only
 the WebSocket and RSocket transports support GraphQL subscriptions, so you'll need to
-create a xref:includes/client.adoc#client.websocketgraphqlclient[WebSocketGraphQlClient] or
-xref:includes/client.adoc#client.rsocketgraphqlclient[RSocketGraphQlClient].
+create a xref:client.adoc#client.websocketgraphqlclient[WebSocketGraphQlClient] or
+xref:client.adoc#client.rsocketgraphqlclient[RSocketGraphQlClient].
 
 
 
 [[client.subscriptions.retrieve]]
 === Retrieve
 
 To start a subscription stream, use `retrieveSubscription` which is similar to
-xref:includes/client.adoc#client.requests.retrieve[retrieve] for a single response but returning a stream of
+xref:client.adoc#client.requests.retrieve[retrieve] for a single response but returning a stream of
 responses, each decoded to some data:
 
 [source,java,indent=0,subs="verbatim,quotes"]
@@ -390,7 +390,7 @@ provides access to the `Subscription`.
 [[client.subscriptions.execute]]
 === Execute
 
-xref:includes/client.adoc#client.subscriptions.retrieve[Retrieve] is only a shortcut to decode from a single path in each
+xref:client.adoc#client.subscriptions.retrieve[Retrieve] is only a shortcut to decode from a single path in each
 response map. For more control, use the `executeSubscription` method and handle each
 response directly: