Migration of GraphQL todo example app to guide

[sdelamo]

See: micronaut-projects/micronaut-graphql#242
Relates to: micronaut-projects/micronaut-graphql#241

To generate the sample projects and the HTML

./gradlew -x micronautGraphqlTodoRunTestScript micronautGraphqlTodoBuild

You can open the HTML at:

open build/dist/index.html

To run the test for every generated project:

`./gradlew micronautGraphqlTodoBuild`

[sdelamo]

@timyates To give you a head start, I created the guide skeleton:

• A new folder under guides with the guide slug micronaut-graphql-todo. That will be part of the guide URL. Thus, it must contain SEO-related terms. We can change this once we understand well what the app is doing.
• Inside that folder, I created the metadata.json file. It defines whether the guide supports multiple languages, the features used by the generated applications, etc.
• I moved the deleted code in the example project to the guide.
• I change the sources package to example.micronaut. Guides generate sample applications with that package. Moreover, some macros (e.g. source:) use that package by default.
• I created the asciidoc file with the typical sections and added macros to show you how to embed sources or resources.

Next steps:

• The example application does not have any tests. We have to add tests. We use guides as a functional test suite for Micronaut. Moreover, I think it is important that we show users that they should test their Micronaut applications and how easy and fast is to do that.
• The example application uses in-memory repositories. We should use JDBC repositories and Flyway or Liquibase for the schema migration. See OpenApI Generator guide or JDBC Guide for an example of how to do that both id code and in the asciidoc sections.
• Go through every source file and write them as idiomatic as possible.
• Write the guide. Add callouts and instructions to Javadoc explaining the sources.

Let me know if you have any doubts.

[timyates]

@sdelamo I think this is ready for you to take a look over, before I extend it to kotlin and groovy

[burtbeckwith]

Why JDK 11? Either way you should use common-requirements.adoc or common-requirements-jdk11.adoc here

[timyates]

I saw the generated build in build/code/micronaut-graphql-todo/micronaut-graphql-todo-gradle-java/build.gradle contained

java {
    sourceCompatibility = JavaVersion.toVersion("11")
    targetCompatibility = JavaVersion.toVersion("11")
}

I will investigate, but I've removed this 11 requirement from the docs for now

[burtbeckwith]

these 3 should be on one line

[timyates]

Replaced this with create-app-features.adoc

[burtbeckwith]

hold -> represent

[burtbeckwith]

also remove "We can" (most instances throughout)

[burtbeckwith]

should have callouts for @Factory and @Bean

[timyates]

I removed @Bean as I believe this is covered by @Singleton... But I added an annotation for @Factory and @Singleton

[burtbeckwith]

I started postgresql in Docker and started the generated app but it fails with error "The server requested password-based authentication, but no password was provided."

[sdelamo]

@sdelamo I think this is ready for you to take a look over, before I extend it to kotlin and groovy

@timyates Please, address @burtbeckwith feedback.

[timyates]

I started postgresql in Docker and started the generated app but it fails with error "The server requested password-based authentication, but no password was provided."

Did you set the environment variables 🤔

https://github.com/micronaut-projects/micronaut-guides/pull/822/files#diff-63446198a1e091f309f808504b1dfefc9b34f0cecb74b46e8114ff4510eae9a0R210-R214

Do we need to make this stand out more in the guide?

[timyates]

I have removed all instances of We (made it more instructional than collaborative), and I believe addressed all the above feedback

Thanks @burtbeckwith 👍

[sdelamo]

@timyates great job.

Always use callouts:

• a7523e0

Try to use as many common callouts as possible. Those ensure guides are consistent and easier to write update.

Try to use common snippets as well.

a7523e0

ae42a04