[docs] fix subscription docs and formatting (ExpediaGroup#1121)

Author: dariuszkuc

website/docs/client/client-features.mdx

@@ -191,11 +191,9 @@ Batch requests are sent as an array of individual GraphQL requests and clients e
 array of GraphQL responses. Each response is then deserialized to a corresponding result type.
 
 ```kotlin
-
 val client = GraphQLKtorClient(url = URL("http://localhost:8080/graphql"))
 val firstQuery = FirstQuery(variables = FirstQuery.Variables(foo = "bar"))
 val secondQuery = SecondQuery(variables = SecondQuery.Variables(foo = "baz"))
 
 val results: List<GraphQLResponse<*>> = client.execute(listOf(firstQuery, secondQuery))
-
 ```

website/docs/graphql-java-comparison.md

@@ -11,7 +11,6 @@ has been used and tested by many users.
 The most common way to create the schema in `graphql-java` is to first manually write the SDL file:
 
 ```graphql
-
 schema {
     query: Query
 }
@@ -32,13 +31,11 @@ type Author {
     firstName: String!
     lastName: String!
 }
-
 ```
 
 Then write the runtime code that matches this schema to build the `GraphQLSchema` object.
 
 ```kotlin
-
 // Internal DB class, not schema class
 class Book(
     val id: ID,
@@ -94,7 +91,6 @@ val runtimeWiring = RuntimeWiring.newRuntimeWiring()
 
 // Combine the types and runtime code together to make a schema
 val graphQLSchema: GraphQLSchema = schemaGenerator.makeExecutableSchema(typeDefinitionRegistry, runtimeWiring)
-
 ```
 
 This means that there are two sources of truth for your schema and changes in either have to be reflected in both locations.
@@ -109,7 +105,6 @@ These errors will hopefully be caught by your build or automated tests, but it i
 All you need to do is write your schema code in a Kotlin class with public functions or properties.
 
 ```kotlin
-
 private val books: List<Book> = booksFromDB()
 private val authors: List<Author> = authorsFromDB()
 
@@ -136,7 +131,6 @@ class Author(
 val config = SchemaGeneratorConfig(supportedPackages = "com.example")
 val queries = listOf(TopLevelObject(Query()))
 val schema: GraphQLSchema = toSchema(config, queries)
-
 ```
 
 This makes changes in code directly reflect to your schema and you can still produce the `GraphQLSchema` to print and export an SDL file.

website/docs/plugins/gradle-plugin-tasks.mdx

@@ -10,7 +10,9 @@ import TabItem from '@theme/TabItem';
 GraphQL Kotlin Gradle Plugin provides functionality to generate a lightweight GraphQL HTTP client and generate GraphQL
 schema directly from your source code.
 
-> NOTE: This plugin is dependent on Kotlin compiler plugin as it generates Kotlin source code that needs to be compiled.
+:::info
+This plugin is dependent on Kotlin compiler plugin as it generates Kotlin source code that needs to be compiled.
+:::
 
 ## Usage
 
@@ -58,18 +60,15 @@ apply(plugin = "com.expediagroup.graphql")
 Using plugins DSL syntax
 
 ```groovy
-
 // build.gradle
 plugins {
     id 'com.expediagroup.graphql' version $graphQLKotlinVersion
 }
-
 ```
 
 Or by using legacy plugin application
 
 ```groovy
-
 // build.gradle
 buildscript {
   repositories {
@@ -83,7 +82,6 @@ buildscript {
 }
 
 apply plugin: "com.expediagroup.graphql"
-
 ```
 
 </TabItem>
@@ -109,7 +107,6 @@ tasks.
 <TabItem value="kotlin">
 
 ```kotlin
-
 // build.gradle.kts
 import com.expediagroup.graphql.plugin.gradle.config.GraphQLScalar
 import com.expediagroup.graphql.plugin.gradle.config.GraphQLSerializer
@@ -148,14 +145,12 @@ graphql {
     packages = listOf("com.example")
   }
 }
-
 ```
 
 </TabItem>
 <TabItem value="groovy">
 
 ```groovy
-
 // build.gradle
 import com.expediagroup.graphql.plugin.gradle.config.GraphQLScalar
 import com.expediagroup.graphql.plugin.gradle.config.GraphQLSerializer
@@ -191,7 +186,6 @@ graphql {
         packages = ["com.example"]
     }
 }
-
 ```
 
 </TabItem>
@@ -208,8 +202,7 @@ All `graphql-kotlin-gradle-plugin` tasks are grouped together under `GraphQL` ta
 `graphql`. You can find detailed information about GraphQL kotlin tasks by running Gradle `help --task <taskName>` task.
 
 ```shell
-
- gradle --tasks
+$ gradle --tasks
 
 GraphQL tasks
 -------------
@@ -218,7 +211,6 @@ graphqlGenerateClient - Generate HTTP client from the specified GraphQL queries.
 graphqlGenerateSDL - Generate GraphQL schema in SDL format.
 graphqlGenerateTestClient - Generate HTTP test client from the specified GraphQL queries.
 graphqlIntrospectSchema - Run introspection query against target GraphQL endpoint and save schema locally.--&gt;
-
 ```
 
 ### graphqlDownloadSDL
@@ -281,11 +273,9 @@ Service provider can be provided as part of your project, included in one of you
 provided artifact to the `graphqlSDL` configuration.
 
 ```kotlin
-
 dependencies {
     graphqlSDL("com.expediagroup:graphql-kotlin-federated-hooks-provider:$graphQLKotlinVersion")
 }
-
 ```
 
 ### graphqlGenerateTestClient

website/docs/plugins/gradle-plugin-usage.mdx

@@ -16,9 +16,7 @@ Language (SDL) directly. `graphqlDownloadSDL` task requires target GraphQL serve
 be executed directly from the command line by explicitly passing `endpoint` parameter
 
 ```shell script
-
 $ gradle graphqlDownloadSDL --endpoint="http://localhost:8080/sdl"
-
 ```
 
 Task can also be explicitly configured in your Gradle build file
@@ -55,18 +53,18 @@ graphqlDownloadSDL {
 </TabItem>
 </Tabs>
 
-&gt; NOTE: This task does not automatically configure itself to be part of your build lifecycle. You will need to explicitly
-&gt; invoke it OR configure it as a dependency of some other task.
+:::info
+This task does not automatically configure itself to be part of your build lifecycle. You will need to explicitly
+invoke it OR configure it as a dependency of some other task.
+:::
 
 ## Introspecting Schema
 
 Introspection task requires target GraphQL server `endpoint` to be specified. Task can be executed directly from the
 command line by explicitly passing endpoint parameter
 
 ```shell script
-
 $ gradle graphqlIntrospectSchema --endpoint="http://localhost:8080/graphql"
-
 ```
 
 Task can also be explicitly configured in your Gradle build file
@@ -103,8 +101,10 @@ graphqlIntrospectSchema {
 </TabItem>
 </Tabs>
 
-&gt; NOTE: This task does not automatically configure itself to be part of your build lifecycle. You will need to explicitly
-&gt; invoke it OR configure it as a dependency of some other task.
+:::info
+This task does not automatically configure itself to be part of your build lifecycle. You will need to explicitly
+invoke it OR configure it as a dependency of some other task.
+:::
 
 ## Generating Client
 
@@ -114,9 +114,7 @@ configuration and storing GraphQL queries under `src/main/resources` directories
 command line by explicitly providing required properties.
 
 ```shell script
-
 $ gradle graphqlGenerateClient --schemaFileName"mySchema.graphql" --packageName="com.example.generated"
-
 ```
 
 Task can also be explicitly configured in your Gradle build file
@@ -166,15 +164,12 @@ custom [scalar converter](https://github.com/ExpediaGroup/graphql-kotlin/blob/ma
 For example given following custom scalar in our GraphQL schema
 
 ```graphql
-
 scalar UUID
-
 ```
 
 We can create a custom converter to automatically convert this custom scalar to `java.util.UUID`
 
 ```kotlin
-
 package com.example
 
 import com.expediagroup.graphql.client.converter.ScalarConverter
@@ -184,7 +179,6 @@ class UUIDScalarConverter : ScalarConverter<UUID> {
     override fun toScalar(rawValue: Any): UUID = UUID.fromString(rawValue.toString()
     override fun toJson(value: UUID): String = value.toString()
 }
-
 ```
 
 Afterwards we need to configure our plugin to use this custom converter
@@ -291,9 +285,7 @@ configuration and storing GraphQL queries under `src/test/resources` directories
 command line by explicitly providing required properties.
 
 ```shell script
-
 $ gradle graphqlGenerateTestClient --schemaFileName"mySchema.graphql" --packageName="com.example.generated"
-
 ```
 
 Task can also be explicitly configured in your Gradle build file
@@ -335,7 +327,9 @@ graphqlGenerateTestClient {
 This will process all GraphQL queries located under `src/test/resources` and generate corresponding GraphQL Kotlin clients.
 Generated classes will be automatically added to the project test compile sources.
 
-> NOTE: `graphqlGenerateTestClient` cannot be configured through the `graphql` extension and has to be explicitly configured.
+:::info
+`graphqlGenerateTestClient` cannot be configured through the `graphql` extension and has to be explicitly configured.
+:::
 
 ## Minimal Client Configuration Example
 
@@ -688,8 +682,10 @@ graphqlGenerateSDL {
 </TabItem>
 </Tabs>
 
->NOTE: This task does not automatically configure itself to be part of your build lifecycle. You will need to explicitly
->invoke it OR configure it as a dependency of some other task.
+:::info
+This task does not automatically configure itself to be part of your build lifecycle. You will need to explicitly
+invoke it OR configure it as a dependency of some other task.
+:::
 
 ## Generating SDL with Custom Hooks Provider Example
 
@@ -776,5 +772,7 @@ dependencies {
 </TabItem>
 </Tabs>
 
->NOTE: This task does not automatically configure itself to be part of your build lifecycle. You will need to explicitly
->invoke it OR configure it as a dependency of some other task.
+:::info
+This task does not automatically configure itself to be part of your build lifecycle. You will need to explicitly
+invoke it OR configure it as a dependency of some other task.
+:::

website/docs/plugins/maven-plugin-goals.md

@@ -7,7 +7,9 @@ sidebar_label: Goals
 GraphQL Kotlin Maven Plugin provides functionality to generate a lightweight GraphQL HTTP client and generate GraphQL
 schema directly from your source code.
 
-> NOTE: This plugin is dependent on Kotlin compiler plugin as it generates Kotlin source code that needs to be compiled.
+:::info
+This plugin is dependent on Kotlin compiler plugin as it generates Kotlin source code that needs to be compiled.
+:::
 
 ## Goals
 

website/docs/plugins/maven-plugin-usage.md

@@ -101,8 +101,10 @@ configuration options that are not available on command line.
 This will process all GraphQL queries located under `src/main/resources` and generate corresponding GraphQL Kotlin client
 data models. Generated classes will be automatically added to the project compile sources.
 
->NOTE: You might need to explicitly add generated clients to your project sources for your IDE to recognize them. See
->[build-helper-maven-plugin](https://www.mojohaus.org/build-helper-maven-plugin/) for details.
+:::note
+You might need to explicitly add generated clients to your project sources for your IDE to recognize them. See
+[build-helper-maven-plugin](https://www.mojohaus.org/build-helper-maven-plugin/) for details.
+:::
 
 ## Generating Client with Custom Scalars
 
@@ -272,8 +274,10 @@ configuration options that are not available on command line.
 This will process all GraphQL queries located under `src/test/resources` and generate corresponding GraphQL Kotlin test clients.
 Generated classes will be automatically added to the project test compile sources.
 
->NOTE: You might need to explicitly add generated test clients to your project test sources for your IDE to recognize them.
->See [build-helper-maven-plugin](https://www.mojohaus.org/build-helper-maven-plugin/) for details.
+:::note
+You might need to explicitly add generated test clients to your project test sources for your IDE to recognize them.
+See [build-helper-maven-plugin](https://www.mojohaus.org/build-helper-maven-plugin/) for details.
+:::
 
 ## Minimal Configuration Example
 
@@ -300,9 +304,11 @@ This generated schema is subsequently used to generate GraphQL client code based
 </plugin>
 ```
 
->NOTE: Both `introspect-schema` and `generate-client` goals are bound to the same `generate-sources` Maven lifecycle phase.
->As opposed to Gradle, Maven does not support explicit ordering of different goals bound to the same build phase. Maven
->Mojos will be executed in the order they are defined in your `pom.xml` build file.
+:::info
+Both `introspect-schema` and `generate-client` goals are bound to the same `generate-sources` Maven lifecycle phase.
+As opposed to Gradle, Maven does not support explicit ordering of different goals bound to the same build phase. Maven
+Mojos will be executed in the order they are defined in your `pom.xml` build file.
+:::
 
 ## Complete Configuration Example
 

website/docs/schema-generator/customizing-schemas/advanced-features.md

@@ -14,16 +14,14 @@ allow you to link to those types from your custom `SchemaGeneratorHooks` impleme
 manually creating the underlying GraphQL type.
 
 ```kotlin
-
 val myConfig = SchemaGeneratorConfig(supportedPackages = listOf("com.example"))
 val generator = SchemaGenerator(myConfig)
 
 val schema = generator.generateSchema(
-        queries = myQueries,
-        additionalTypes = setOf(MyCustomObject::class.createType()),
-        additionalInputTypes = setOf(MyCustomInputObject::class.createType())
+    queries = myQueries,
+    additionalTypes = setOf(MyCustomObject::class.createType()),
+    additionalInputTypes = setOf(MyCustomInputObject::class.createType())
 )
-
 ```
 
 ### `SchemaGenerator::addAdditionalTypesWithAnnotation`

website/docs/schema-generator/customizing-schemas/deprecating-schema.md

@@ -7,26 +7,22 @@ GraphQL schemas can have fields marked as deprecated. Instead of creating a cust
 for the deprecated reason.
 
 ```kotlin
-
 class SimpleQuery {
   @Deprecated(message = "this query is deprecated", replaceWith = ReplaceWith("shinyNewQuery"))
   fun simpleDeprecatedQuery(): Boolean = false
 
   fun shinyNewQuery(): Boolean = true
 }
-
 ```
 
 The above query would produce the following GraphQL schema:
 
 ```graphql
-
 type Query {
   simpleDeprecatedQuery: Boolean! @deprecated(reason: "this query is deprecated, replace with shinyNewQuery")
 
   shinyNewQuery: Boolean!
 }
-
 ```
 
 While you can deprecate any fields/functions/classes in your Kotlin code, GraphQL only supports deprecation directive on