Simplfy repeated information in the docs (#754)

* Simplfy repeated information in the docs

* Remove expedia specific lockfile

* PR comments

* Reorder main gettings started sections

* Update registry to public npm

* Move npmrc to specific npm folders

Co-authored-by: Shane Myrick <[email protected]>

Author: smyrick

SECURITY.md .github/SECURITY.mdSECURITY.md renamed to .github/SECURITY.md

@@ -63,7 +63,7 @@ Further instructions on how to add documentation content are in `website/README.
 All source files must contain the following license header. If you are using an IDE please add this as a copyright template for this project so that it will be added automatically.
 
 ```
-Copyright 2020 Expedia, Inc
+Copyright ${today.year} Expedia, Inc
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

CONTRIBUTING.md

@@ -5,7 +5,7 @@
 [![codecov](https://codecov.io/gh/ExpediaGroup/graphql-kotlin/branch/master/graph/badge.svg)](https://codecov.io/gh/ExpediaGroup/graphql-kotlin)
 [![Slack](https://img.shields.io/badge/Slack-%23graphql--kotlin-ECB22E.svg?logo=data:image/svg+xml;base64,PHN2ZyB2aWV3Qm94PSIwIDAgNTQgNTQiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+PGcgZmlsbD0ibm9uZSIgZmlsbC1ydWxlPSJldmVub2RkIj48cGF0aCBkPSJNMTkuNzEyLjEzM2E1LjM4MSA1LjM4MSAwIDAgMC01LjM3NiA1LjM4NyA1LjM4MSA1LjM4MSAwIDAgMCA1LjM3NiA1LjM4Nmg1LjM3NlY1LjUyQTUuMzgxIDUuMzgxIDAgMCAwIDE5LjcxMi4xMzNtMCAxNC4zNjVINS4zNzZBNS4zODEgNS4zODEgMCAwIDAgMCAxOS44ODRhNS4zODEgNS4zODEgMCAwIDAgNS4zNzYgNS4zODdoMTQuMzM2YTUuMzgxIDUuMzgxIDAgMCAwIDUuMzc2LTUuMzg3IDUuMzgxIDUuMzgxIDAgMCAwLTUuMzc2LTUuMzg2IiBmaWxsPSIjMzZDNUYwIi8+PHBhdGggZD0iTTUzLjc2IDE5Ljg4NGE1LjM4MSA1LjM4MSAwIDAgMC01LjM3Ni01LjM4NiA1LjM4MSA1LjM4MSAwIDAgMC01LjM3NiA1LjM4NnY1LjM4N2g1LjM3NmE1LjM4MSA1LjM4MSAwIDAgMCA1LjM3Ni01LjM4N20tMTQuMzM2IDBWNS41MkE1LjM4MSA1LjM4MSAwIDAgMCAzNC4wNDguMTMzYTUuMzgxIDUuMzgxIDAgMCAwLTUuMzc2IDUuMzg3djE0LjM2NGE1LjM4MSA1LjM4MSAwIDAgMCA1LjM3NiA1LjM4NyA1LjM4MSA1LjM4MSAwIDAgMCA1LjM3Ni01LjM4NyIgZmlsbD0iIzJFQjY3RCIvPjxwYXRoIGQ9Ik0zNC4wNDggNTRhNS4zODEgNS4zODEgMCAwIDAgNS4zNzYtNS4zODcgNS4zODEgNS4zODEgMCAwIDAtNS4zNzYtNS4zODZoLTUuMzc2djUuMzg2QTUuMzgxIDUuMzgxIDAgMCAwIDM0LjA0OCA1NG0wLTE0LjM2NWgxNC4zMzZhNS4zODEgNS4zODEgMCAwIDAgNS4zNzYtNS4zODYgNS4zODEgNS4zODEgMCAwIDAtNS4zNzYtNS4zODdIMzQuMDQ4YTUuMzgxIDUuMzgxIDAgMCAwLTUuMzc2IDUuMzg3IDUuMzgxIDUuMzgxIDAgMCAwIDUuMzc2IDUuMzg2IiBmaWxsPSIjRUNCMjJFIi8+PHBhdGggZD0iTTAgMzQuMjQ5YTUuMzgxIDUuMzgxIDAgMCAwIDUuMzc2IDUuMzg2IDUuMzgxIDUuMzgxIDAgMCAwIDUuMzc2LTUuMzg2di01LjM4N0g1LjM3NkE1LjM4MSA1LjM4MSAwIDAgMCAwIDM0LjI1bTE0LjMzNi0uMDAxdjE0LjM2NEE1LjM4MSA1LjM4MSAwIDAgMCAxOS43MTIgNTRhNS4zODEgNS4zODEgMCAwIDAgNS4zNzYtNS4zODdWMzQuMjVhNS4zODEgNS4zODEgMCAwIDAtNS4zNzYtNS4zODcgNS4zODEgNS4zODEgMCAwIDAtNS4zNzYgNS4zODciIGZpbGw9IiNFMDFFNUEiLz48L2c+PC9zdmc+&labelColor=611f69)](https://kotlinlang.slack.com/messages/graphql-kotlin/)
 
-GraphQL Kotlin is a collection of libraries built on top of [graphql-java](https://www.graphql-java.com/) that aim to simplify running a GraphQL server in Kotlin
+GraphQL Kotlin is a collection of libraries, built on top of [graphql-java](https://www.graphql-java.com/), that aim to simplify running GraphQL in Kotlin
 
 ## 📦 Modules
 
@@ -19,25 +19,27 @@ GraphQL Kotlin is a collection of libraries built on top of [graphql-java](https
 
 ## ⌨️ Usage
 
-Below is a basic example of how [graphql-kotlin-schema-generator](/graphql-kotlin-schema-generator) converts your Kotlin code into a GraphQL schema. For more details, see our documentation below or in the individual module READMEs
+Below is a basic example of how you can use [graphql-kotlin-spring-server](/graphql-kotlin-spring-server) to run a GraphQL server. For more details, see our documentation below or in the individual module READMEs
 
 ```kotlin
+// Simple data class that is parsed by the schema generator
 data class Widget(val id: Int, val value: String)
 
-class WidgetService {
-  fun widgetById(id: Int): Widget? {
-    // grabs widget from a data source, might return null
-  }
+// Mark the class as a Spring GraphQL Query
+@Component
+class WidgetService : Query {
+  fun widgetById(id: Int): Widget? = null
 }
 
-// Generate the schema
-val config = SchemaGeneratorConfig(supportedPackages = listOf("org.example"))
-val queries = listOf(TopLevelObject(WidgetService()))
+@SpringBootApplication
+class Application
 
-toSchema(config, queries)
+fun main(args: Array<String>) {
+    runApplication<Application>(*args)
+}
 ```
 
-will generate
+will generate a server at `/graphql` and `/playground` with the following schema
 
 ```graphql
 type Query {
@@ -50,23 +52,6 @@ type Widget {
 }
 ```
 
-Then using [graphql-kotlin-spring-server](/graphql-kotlin-spring-server) you can easily make your schema available as a GraphQL server with Spring Boot.
-
-```kotlin
-// Mark the class as a Spring GraphQL Query
-@Component
-class WidgetService : Query {
-  fun widgetById(id: Int): Widget? {}
-}
-
-@SpringBootApplication
-class Application
-
-fun main(args: Array<String>) {
-    runApplication<Application>(*args)
-}
-```
-
 ## 📋 Documentation
 
 Examples and documentation are available on our [documentation site](https://expediagroup.github.io/graphql-kotlin) hosted in GitHub Pages.
@@ -79,12 +64,12 @@ If you would like to contribute to our documentation see the [website](/website)
 
 This project is part of Expedia Group Open Source but also maintained by a dedicated team
 
-* Expedia Group
+* Expedia Group OSS
   * https://expediagroup.github.io
   * oss@expediagroup.com
 
-* `@ExpediaGroup/graphql-kotlin-committers`
-  * Tag us in an issue on Github
+* GraphQL Kotlin Committers
+  * Github team: `@ExpediaGroup/graphql-kotlin-committers`
   * We also have a public channel, ([#graphql-kotlin](https://app.slack.com/client/T09229ZC6/CQLNT7B29)), open on the Kotlin Slack instance. See the info [here on how to join this slack instance](https://slack.kotlinlang.org/)
 
 ## ✏️ Contributing
@@ -98,5 +83,9 @@ To get started, please fork the repo and checkout a new branch. You can then bui
 
 See more info in [CONTRIBUTING.md](CONTRIBUTING.md)
 
+## 🛡️ Security
+
+For more info on how to contact the team for security issues or the supported versions that recieve security updates, see [SECURITY.md](./github/SECURITY.md).
+
 ## ⚖️ License
 This library is licensed under the [Apache License, Version 2.0](LICENSE)

README.md

@@ -16,6 +16,8 @@ Articles and videos specifically about `graphql-kotlin`
 * 📝 [Apollo Federation in a GraphQL Kotlin Server](https://medium.com/expedia-group-tech/apollo-federation-in-a-graphql-kotlin-server-115cea51607a)
 * 📝 [Creating a Reactive GraphQL Server with Spring Boot and Kotlin](https://medium.com/expedia-group-tech/creating-a-reactive-graphql-server-with-spring-boot-and-kotlin-54aca7316470)
 * 📺 [Bootiful GraphQL with Kotlin (Dariusz Kuc, Guillaume Scheibel)](https://www.youtube.com/watch?v=7YJyPXjLdug&index=25) (en)
+* 📝 [🎉 Announcing graphql-kotlin 2.0!](https://medium.com/expedia-group-tech/graphql-kotlin-2-0-4006ea41f774)
+* 📝 [Introducing GraphQL Kotlin Client](https://medium.com/expedia-group-tech/introducing-graphql-kotlin-client-b32dc3061a6f)
 
 #### GraphQL
 Articles and videos about how Expedia Group is using GraphQL

docs/blogs-and-videos.md

@@ -3,6 +3,12 @@ id: examples
 title: Examples
 ---
 
+A collection of example apps that use graphql-kotlin libraries to test and demonstrate usages can be found in the [examples module](https://github.com/ExpediaGroup/graphql-kotlin/tree/master/examples).
+
+## Client Example
+
+A `graphql-kotlin-client` can be generated using the Maven and Gradle plugins in `graphql-kotlin-plugins`. For examples see the [examples/client](https://github.com/ExpediaGroup/graphql-kotlin/tree/master/examples/client) folder.
+
 ## Spring Server Example
 
 One way to run a GraphQL server is with [Spring Boot](https://github.com/spring-projects/spring-boot). A sample Spring

docs/examples.md

@@ -3,20 +3,22 @@ id: getting-started
 title: Getting Started
 ---
 
-GraphQL Kotlin is a collection of libraries built on top of [graphql-java](https://www.graphql-java.com/) that aim to simplify running a GraphQL server in Kotlin
+GraphQL Kotlin is a collection of libraries, built on top of [graphql-java](https://www.graphql-java.com/), that aim to simplify running GraphQL in Kotlin
 
 ## Modules
 
+* [examples](https://github.com/ExpediaGroup/graphql-kotlin/tree/master/examples)
+  — Example apps that use graphql-kotlin libraries to test and demonstrate usages
 * [graphql-kotlin-client](https://github.com/ExpediaGroup/graphql-kotlin/tree/master/graphql-kotlin-client) ([Javadoc](https://www.javadoc.io/doc/com.expediagroup/graphql-kotlin-client))
   — Lightweight GraphQL Kotlin HTTP client
 * [graphql-kotlin-schema-generator](https://github.com/ExpediaGroup/graphql-kotlin/tree/master/graphql-kotlin-schema-generator) ([Javadoc](https://www.javadoc.io/doc/com.expediagroup/graphql-kotlin-schema-generator))
   — Code only GraphQL schema generation for Kotlin
 * [graphql-kotlin-federation](https://github.com/ExpediaGroup/graphql-kotlin/tree/master/graphql-kotlin-federation) ([Javadoc](https://www.javadoc.io/doc/com.expediagroup/graphql-kotlin-federation))
   — Schema generator extension to build federated GraphQL schemas
 * [graphql-kotlin-spring-server](https://github.com/ExpediaGroup/graphql-kotlin/tree/master/graphql-kotlin-spring-server) ([Javadoc](https://www.javadoc.io/doc/com.expediagroup/graphql-kotlin-spring-server))
-  — Spring Boot auto-configuration library to create GraphQL web app
-* [examples](https://github.com/ExpediaGroup/graphql-kotlin/tree/master/examples)
-  — Example apps that use graphql-kotlin libraries to test and demonstrate usages
+  — Spring Boot auto-configuration library to create GraphQL server
+* [graphql-kotlin-types](https://github.com/ExpediaGroup/graphql-kotlin/tree/master/graphql-kotlin-types) ([Javadoc](https://www.javadoc.io/doc/com.expediagroup/graphql-kotlin-types))
+— Core types used by both client and server
 * [plugins](https://github.com/ExpediaGroup/graphql-kotlin/tree/master/plugins)
   — GraphQL Kotlin Gradle and Maven plugins
 
@@ -30,96 +32,44 @@ Additional resources
 
 ## Installation
 
-Using a JVM dependency manager, simply link `graphql-kotlin-schema-generator` to your project. You can see the latest
+Using a JVM dependency manager, simply link any `graphql-kotlin-*` library to your project. You can see the latest
 version and other examples in [Sonatype Central
-Repository](https://search.maven.org/artifact/com.expediagroup/graphql-kotlin-schema-generator)
+Repository](https://search.maven.org/artifact/com.expediagroup/graphql-kotlin-spring-server)
 
 ### Maven
 
 ```xml
 <dependency>
   <groupId>com.expediagroup</groupId>
-  <artifactId>graphql-kotlin-schema-generator</artifactId>
+  <artifactId>graphql-kotlin-spring-server</artifactId>
   <version>${latestVersion}</version>
 </dependency>
 ```
 
 ### Gradle
 
 ```groovy
-compile(group: 'com.expediagroup', name: 'graphql-kotlin-schema-generator', version: "$latestVersion")
-```
-
-## Generating a schema
-
-`graphql-kotlin-schema-generator` provides a single function, `toSchema`, to generate a schema from Kotlin objects.
-
-```kotlin
-class Query {
-  fun getNumber() = 1
-}
-
-val config = SchemaGeneratorConfig(listOf("com.expediagroup"))
-val queries = listOf(TopLevelObject(Query()))
-val schema: GraphQLSchema = toSchema(config = config, queries = queries)
+compile(group: 'com.expediagroup', name: 'graphql-kotlin-spring-server', version: "$latestVersion")
 ```
 
-generates a `GraphQLSchema` with IDL that looks like this:
+## Generating a Schema
 
-```graphql
-schema {
-  query: Query
-}
+While we have included a server implementation, you can use `graphql-kotlin-schema-generator` to generate a schema from Kotlin code and expose it with any server library.
 
-type Query {
-  getNumber: Int!
-}
-```
+See the docs in [Schema Generator Getting Started](./schema-generator/schema-generator-getting-started.md).
 
-The `GraphQLSchema` generated can be used to expose a GraphQL API endpoint.
+### Federation
 
-### `toSchema`
+Using `graphql-kotlin-federation`, you can generate an [Apollo Federation](https://www.apollographql.com/docs/apollo-server/federation/federation-spec/) complaint schema.
 
-This function accepts four arguments: `config`, `queries`, `mutations` and `subscriptions`. The `queries`, `mutations`
-and `subscriptions` are a list of `TopLevelObject`s and will be used to generate corresponding GraphQL root types. See
-below on why we use this wrapper class. The `config` contains all the extra information you need to pass, including
-custom hooks, supported packages, and name overrides. See the full documentation: [Spring Server Overview](spring-server/spring-overview).
+See the docs in [Apollo Federation](./federated/apollo-federation.md).
 
-You can see the definition for `toSchema` [in the
-source](https://github.com/ExpediaGroup/graphql-kotlin/blob/master/graphql-kotlin-schema-generator/src/main/kotlin/com/expediagroup/graphql/toSchema.kt)
+## Running a Server
+`graphql-kotlin-spring-server` is a combination of the schema generator, fedeation, and server libraries. If you are looking to run a GraphQL server, this is the place to start.
 
-### Class `TopLevelObject`
+See the docs in [Spring Server Overview](./spring-server/spring-overview.md).
 
-`toSchema` uses Kotlin reflection to build a GraphQL schema from given classes using `graphql-java`'s schema builder. We
-don't just pass a `KClass` though, we have to actually pass an object, because the functions on the object are
-transformed into the data fetchers. In most cases, a `TopLevelObject` can be constructed with just an object:
+## Creating a Client
+`graphql-kotlin-plugins` can be used to generate a `graphql-kotlin-client` from an existing schema that is easy to use and type-safe.
 
-```kotlin
-class Query {
-  fun getNumber() = 1
-}
-
-val topLevelObject = TopLevelObject(Query())
-
-toSchema(config = config, queries = listOf(topLevelObject))
-```
-
-In the above case, `toSchema` will use `topLevelObject::class` as the reflection target, and `Query` as the data fetcher
-target.
-
-In a lot of cases, such as with Spring AOP, the object (or bean) being used to generate a schema is a dynamic proxy. In
-this case, `topLevelObject::class` is not `Query`, but rather a generated class that will confuse the schema generator.
-To specify the `KClass` to use for reflection on a proxy, pass the class to `TopLevelObject`:
-
-```kotlin
-@Component
-class Query {
-  @Timed
-  fun getNumber() = 1
-}
-
-val query = getObjectFromBean()
-val customDef = TopLevelObject(query, Query::class)
-
-toSchema(config, listOf(customDef))
-```
+See the docs in [Client Overview](./client/client-overview.md).