My second application tutorial #34401

holly-cummins · 2023-06-28T21:34:17Z

Resolves #31618

The companion code lives in quarkusio/quarkus-quickstarts#1293.

I'll mark this as a draft and work with the docs team.

maxandersen · 2023-07-11T15:10:29Z

this looks good to me! +1 on adding it asap.

@cescoffier i know you were encouraging we got something similar to this as part of getting started.

cescoffier · 2023-07-11T15:11:28Z

It's on my review list - will squeeze it tomorrow

github-actions · 2023-07-11T17:45:29Z

🙈 The PR is closed and the preview is expired.

docs/src/main/asciidoc/getting-started-dev-services.adoc

cescoffier · 2023-07-12T09:31:39Z

docs/src/main/asciidoc/getting-started-dev-services.adoc

+git clone {quickstarts-clone-url}
+----
+
+The solution is located in the `getting-started-dev-services` {quickstarts-tree-url}/getting-started-dev-services[directory].


Why 'dev-service', shouldn't it be 'crud' ?

I don't think it could be 'rest', because https://github.com/quarkusio/quarkus-quickstarts/tree/main/getting-started is a rest application. It could be 'crud' ... to me, dev services was the big gap that we didn't have content for, so I named it that way. But you're right that crud is the characteristic feature of the application code, and we do already have https://github.com/quarkusio/quarkus-quickstarts/tree/main/getting-started-reactive-crud/. So I'll rename it that way to be consistent.

There's also overlap between the app and https://github.com/quarkusio/quarkus-quickstarts/tree/main/hibernate-orm-panache-quickstart, but the 'crud' name doesn't make the overlap worse, just more obvious. :) The key difference is that one is designed to be coded by a user and the other is intended to be downloaded on app creation, so I think it's right that they stay separate.

Actually, I think I've changed my mind again. getting-started-dev-services seems like the right file name for this article, and then people would expect that the code in the other repo would have the same name as the article.

docs/src/main/asciidoc/getting-started-dev-services.adoc

cescoffier · 2023-07-12T09:46:55Z

docs/src/main/asciidoc/getting-started-dev-services.adoc

+Now, try stopping and starting your application, and then visiting http://localhost:8080/hello/names.
+You'll see that Alice and Bob are always included in the list of names.
+
+== Controlling dev services


I'm wondering if the rest of the document should be in this guide or a more "reference" guide.

To me, it feels like we're leaving people with an incomplete picture if we don't include it; we've told them about dev services, but not giving them any hints about what happens if they don't want to use dev services. They might think they can't use a real database with Quarkus, and I'm not sure we want them to have to go read the both configuration reference and the dev services reference to figure out that it's possible. "Use profiles to conditionally enable dev services" would span the two references, which is an extra barrier to people figuring out the idea on their own.

gsmet · 2023-07-12T13:05:09Z

Just a note that I would like to have a look at this before we merge. I’ll have a look next Tuesday when I’m back from Riviera DEV.

holly-cummins · 2023-07-13T10:27:15Z

Thanks for the review, @cescoffier! Updates pushed.

gsmet

Thanks for that. I spotted a few things. Some are minor, some not so much, please have a look :).

gsmet · 2023-07-13T10:40:18Z

docs/src/main/asciidoc/getting-started-dev-services.adoc

+
+This tutorial shows you how to create an application which writes to and reads from a database.
+You will use Dev Services, so you will not actually download, configure, or even start the database yourself.
+You will use Panache to make reading and writing data easier.


We have the Logging with Panache too so I wonder if we should be more specific? But it's just a proposal, the current wording somehow works for me.

Suggested change

You will use Panache to make reading and writing data easier.

You will use Hibernate ORM with Panache to make reading and writing data easier.

"Logging with Panache" reminds me I meant to ask about that bit of the docs. Done now.. Perhaps some of this discussion goes on that PR.

I'm in two minds about your proposal

Keep as is

We want to walk people through what's new and different in Quarkus, so should focus on the new bit, ie Panache

"Hibernate ORM with Panache" is a bit of a mouthful

Revise

Hibernate is familiar to people and helps anchor their understand

What about "You will use Panache, a layer on top of Hibernate ORM, to make reading and writing data easier.'? That's less consistent with our 'x with Panache' convention, but more consistent with how external people refer to Panache.

Well, we have a convention, we should follow it.

That being said You will use Panache, a layer on top of Hibernate ORM, to make reading and writing data easier is not bad. But really, if everyone has their own version of it, it's going to be a mess.

docs/src/main/asciidoc/getting-started-dev-services.adoc

holly-cummins · 2023-07-13T18:07:03Z

Thanks, @gsmet! I've committed all the small suggestions and implemented the bigger ones, except the one or two still open, about naming things.

holly-cummins · 2023-07-13T19:38:28Z

Oh, whoops, I'd missed 25 suggestions that the GitHub UI was hiding from me. Ok, now I think I've got them all.

gsmet

I spotted a micro issue in the Windows note.

Also this needs a big squash.

docs/src/main/asciidoc/_includes/devtools/create-app.adoc

gsmet · 2023-07-21T12:53:41Z

docs/src/main/asciidoc/getting-started-dev-services.adoc

+
+This tutorial shows you how to create an application which writes to and reads from a database.
+You will use Dev Services, so you will not actually download, configure, or even start the database yourself.
+You will use Panache to make reading and writing data easier.


That being said You will use Panache, a layer on top of Hibernate ORM, to make reading and writing data easier is not bad. But really, if everyone has their own version of it, it's going to be a mess.

Squashed to include review comments. Co-Authored-By: Guillaume Smet <guillaume.smet@gmail.com>

gsmet · 2023-07-25T14:57:49Z

Thanks!

quarkus-bot bot added the area/documentation label Jun 28, 2023

holly-cummins mentioned this pull request Jun 28, 2023

"My Second Quarkus Application" guide #31618

Closed

holly-cummins force-pushed the my-second-application-guide branch from 317f349 to a0085b5 Compare June 28, 2023 21:37

holly-cummins mentioned this pull request Jun 28, 2023

Add application code to support "My second application" Guide quarkusio/quarkus-quickstarts#1293

Merged

10 tasks

cescoffier self-requested a review July 11, 2023 15:11

holly-cummins force-pushed the my-second-application-guide branch from a0085b5 to c915ebe Compare July 11, 2023 16:32

cescoffier requested changes Jul 12, 2023

View reviewed changes

holly-cummins force-pushed the my-second-application-guide branch from 748abc1 to 29ab089 Compare July 13, 2023 10:27

gsmet requested changes Jul 13, 2023

View reviewed changes

holly-cummins force-pushed the my-second-application-guide branch from 7333f12 to e8f57c2 Compare July 13, 2023 18:05

gsmet requested changes Jul 21, 2023

View reviewed changes

holly-cummins force-pushed the my-second-application-guide branch from ca4e532 to 9a92ddb Compare July 24, 2023 16:42

My second application tutorial

774b436

Squashed to include review comments. Co-Authored-By: Guillaume Smet <guillaume.smet@gmail.com>

holly-cummins force-pushed the my-second-application-guide branch from 9a92ddb to 774b436 Compare July 24, 2023 16:43

gsmet approved these changes Jul 25, 2023

View reviewed changes

gsmet merged commit 740e13a into quarkusio:main Jul 25, 2023
5 checks passed

quarkus-bot bot added the kind/enhancement New feature or request label Jul 25, 2023

quarkus-bot bot added this to the 3.3 - main milestone Jul 25, 2023

holly-cummins deleted the my-second-application-guide branch July 25, 2023 15:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

My second application tutorial #34401

My second application tutorial #34401

holly-cummins commented Jun 28, 2023 •

edited

Loading

maxandersen commented Jul 11, 2023

cescoffier commented Jul 11, 2023

github-actions bot commented Jul 11, 2023 •

edited

Loading

cescoffier Jul 12, 2023

cescoffier Jul 12, 2023

holly-cummins Jul 12, 2023 •

edited

Loading

holly-cummins Jul 12, 2023

cescoffier Jul 12, 2023

holly-cummins Jul 13, 2023

gsmet commented Jul 12, 2023

holly-cummins commented Jul 13, 2023

gsmet left a comment

gsmet Jul 13, 2023

holly-cummins Jul 13, 2023

gsmet Jul 21, 2023

gsmet Jul 21, 2023

holly-cummins commented Jul 13, 2023

holly-cummins commented Jul 13, 2023

gsmet left a comment

gsmet Jul 21, 2023

gsmet commented Jul 25, 2023

	You will use Panache to make reading and writing data easier.
	You will use Hibernate ORM with Panache to make reading and writing data easier.

My second application tutorial #34401

My second application tutorial #34401

Conversation

holly-cummins commented Jun 28, 2023 • edited Loading

maxandersen commented Jul 11, 2023

cescoffier commented Jul 11, 2023

github-actions bot commented Jul 11, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

holly-cummins Jul 12, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gsmet commented Jul 12, 2023

holly-cummins commented Jul 13, 2023

gsmet left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

holly-cummins commented Jul 13, 2023

holly-cummins commented Jul 13, 2023

gsmet left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gsmet commented Jul 25, 2023

holly-cummins commented Jun 28, 2023 •

edited

Loading

github-actions bot commented Jul 11, 2023 •

edited

Loading

holly-cummins Jul 12, 2023 •

edited

Loading