Update reference documentation with a link to "GraphQL Server" Getting Started Guide

[dondonz]

Hello, I'm wondering what the process is for adding a Spring for GraphQL guide to https://spring.io/guides?

Is it possible to add a link to the graphql-java Spring for GraphQL tutorial https://www.graphql-java.com/tutorials/getting-started-with-spring-boot? Or I can help write a new tutorial.

[bclozel]

Hello @dondonz, this tutorial looks nice thanks for writing it!
We're indeed considering one or more guides on spring.io, but didn't start yet. We can discuss and organize in this issue.

What did you have in mind for a new guide on spring.io - something very similar to the graphql-java.com one or would you like to use another angle?

We can link to the graphql-java.com tutorial from our reference documentation, project page or another spring.io/guide. I'm not sure the infrastructure would allow us to add a new guide entry that would link to graphql-java.com though.

[dondonz]

Ok great, I'm keen to help write guides! I'm happy to work with you on ideas, it could be a quick start guide like the graphql-java.com one, or could be more detailed. Did you & the team have any ideas in mind?

This idea came from my colleague, who was trying out Spring for GraphQL for the first time. One of the first places he visited for more info was spring.io/guide.

[rstoyanchev]

I think a getting-started guide under https://spring.io/guides#getting-started-guides, similar to the one you have created is an obvious first step. It might be possible to add a test with GraphQlTester as well.

[dondonz]

Good idea to add tests.

We're getting ready to release graphql-java v20 at the moment. After that's done I'll come back to writing this guide

[rstoyanchev]

Thanks, this is the repository for the GSG guides.

[bclozel]

@rstoyanchev we'll need to request the creation of a new repository in the org, as getting-started-guides is merely the template that @dondonz can use to start with (but should not submit a PR to).

What should be the name of the repository? "spring-guides/gs-graphql-server"? "spring-guides/gs-graphql-server-mvc"? At first, when we create the repo we should drop the "gs-" prefix as otherwise this will publish it instantly.

[rstoyanchev]

"spring-guides/gs-graphql-server" sounds good.

[dondonz]

Thanks @bclozel for setting up the repo!

[bclozel]

You can start a PR on and we can iterate on it with you!
https://github.com/spring-guides/graphql-server

Let's continue there - we'll keep this issue opened until the guide is properly published.

[dondonz]

Thanks!!

[dondonz]

Could you please add me to the repo? I don't have push permissions at the moment.

Or alternatively I can create a PR via a fork. If you'd prefer to use forks, could you please commit an empty README.adoc file to enable forking?

[rstoyanchev]

I've added a README.

[dondonz]

Thanks!

As an update I've been working on the guide this weekend, I'll put up a PR when I'm done with the first proper draft.

[dondonz]

Here's my first draft - feel free to comment and edit as you like. More in PR description: spring-guides/gs-graphql-server#1

[rstoyanchev]

I've left initial feedback on the PR. Let's continue the discussion there. I'll re-purpose this issue as a documentation update to link to the guide from our reference docs.