Proofread the tutorial - Githubissues

redhat-developer-demos / quarkus-tutorial

Quarkus Tutorial for https://dn.dev/quarkusmaster

https://redhat-developer-demos.github.io/quarkus-tutorial/

Apache License 2.0

152 stars 86 forks source link

Proofread the tutorial #156

Closed gsmet closed 4 months ago

gsmet commented 4 months ago

I went through all the content and made the following changes:

fixed typos
reported some issues that were not that easy to fix (for instance the use of dead punkapi.com in some sections)
adjusted the first tutorials to use Jackson instead of JSON-B: we recommend using Jackson. Also it avoids having to go back to switch from JSON-B to Jackson when dealing with Spring
the reactive sections are still using JSON-B for two reasons: they are using some JSON-P features and I couldn't test things given the API is not available. When reworking them, we should switch them to Jackson too.

This is a bit massive, I will go through the changes and add comments when they are needed.

gsmet commented 4 months ago

@kdubois once you agree on the changes, let me do a pass to check that I didn't break the formatting (unclosed backticks for instance). I will do it locally but let's agree on the changes first so that I don't do it twice.

kdubois commented 4 months ago

Looks great, thanks for going through and fixing / improving the content! I like the switch to Jackson as well.

gsmet commented 4 months ago

@kdubois OK, I went through the content again, and went through the all the steps I changed (so until REST Client).

Things work but I had some bad surprises with dev mode when adding the extensions. Once, dev mode somehow didn't reload the model properly and I ended up with some classes (the MicroProfile REST Client ones) being missing.

Even using s didn't fix it.

It worked after a full restart of the dev mode.

I'll try to reproduce this but it doesn't seem fully reproducible and is not related to my changes so I would say all these changes are good to go.

gsmet commented 4 months ago

@kdubois I added a small step to make sure people wait for Quarkus to be reloaded after having added an extension. Once PostgreSQL is installed, you have the Dev Service starting and it's relatively slow.

I think that might explain what I saw (but we should try to see how we could fix it to survive the issue)

gsmet commented 4 months ago

@kdubois it would be nice to get this merged and published before next week as we are going to use this for the workshop at JCon.

Thanks!

kdubois commented 4 months ago

LGTM!