Fix doc extension-add.adoc #36452

leo-bogastry · 2023-10-12T15:04:29Z

Going through the getting-started-dev-services page I was not able to run the quarkus command to install extensions without removing the single quotes. I'm using Quarkus CLI version 3.4.2 on macOs.

I also noticed a small error in the text format so I also fixed that.

gsmet

Marking as "Request changes" until we make sure this change is safe on most shells/OSes.

gsmet · 2023-10-12T15:07:38Z

docs/src/main/asciidoc/_includes/devtools/extension-add.adoc

@@ -1,7 +1,7 @@
 [source,bash,subs=attributes+, role="primary asciidoc-tabs-sync-cli"]
 .CLI
 ----
-quarkus extension add '{add-extension-extensions}'
+quarkus extension add {add-extension-extensions}


Thanks but let's not rush this in as I think it was a bit hard to find a combination that was more or less working for several shells (and OSes).

BTW, if you happen to have a Linux/Windows/macOS boxes (or colleagues with them), it would be nice to test this command with one and multiple extensions (and on Windows, in cmd and Powershell).

Once we have this feedback, we can make an educated decision.

I managed to test the Quarkus Cli using virtual machines 😅
The conclusion is that the command to add extensions always works without quotes for both the cases of adding one or more extensions, across the 3 operating systems.

In detail:

Description with quotes without quotes

MacOs Sonoma: one extension ✅ ✅

MacOs Sonoma: multiple extensions ❌ ✅

Ubuntu 22.04.3: one extension ✅ ✅

Ubuntu 22.04.3: multiple extensions ❌ ✅

Windows command line: one extension ❌ ✅

Windows command line: multiple extensions ❌ ✅

Windows powershell: one extension ✅ ✅

Windows powershell: multiple extensions ❌ ✅

Some screenshots:
quarkus-cli.zip

gsmet · 2023-10-12T15:08:26Z

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

@@ -79,7 +79,7 @@ Once the application is up, visit http://localhost:8080/hello. It should show a
 === Accepting user input

 Let's make the application a bit more interactive.
-Open the project in your IDE and navigate to `src/main/java/org/acme/GreetingResource.java'
+Open the project in your IDE and navigate to `src/main/java/org/acme/GreetingResource.java`


Good catch, we will get this in anyway!

github-actions · 2023-10-12T17:57:30Z

🙈 The PR is closed and the preview is expired.

gsmet

Thanks for taking the time to test all these permutations.

Will merge, now, thanks!

This MR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [flow-bin](https://github.com/flowtype/flow-bin) ([changelog](https://github.com/facebook/flow/blob/master/Changelog.md)) | devDependencies | minor | [`^0.219.0` -> `^0.220.0`](https://renovatebot.com/diffs/npm/flow-bin/0.219.0/0.220.0) | | [org.jsoup:jsoup](https://jsoup.org/) ([source](https://github.com/jhy/jsoup)) | compile | patch | `1.16.1` -> `1.16.2` | | [io.quarkus:quarkus-maven-plugin](https://github.com/quarkusio/quarkus) | build | minor | `3.4.3` -> `3.5.0` | | [io.quarkus:quarkus-universe-bom](https://github.com/quarkusio/quarkus-platform) | import | minor | `3.4.3` -> `3.5.0` | --- ### Release Notes <details> <summary>flowtype/flow-bin</summary> ### [`v0.220.0`](flow/flow-bin@f7f3f3f...030bfc6) [Compare Source](flow/flow-bin@f7f3f3f...030bfc6) ### [`v0.219.5`](flow/flow-bin@f16a6c7...f7f3f3f) [Compare Source](flow/flow-bin@f16a6c7...f7f3f3f) ### [`v0.219.4`](flow/flow-bin@9f67075...f16a6c7) [Compare Source](flow/flow-bin@9f67075...f16a6c7) ### [`v0.219.3`](flow/flow-bin@80dcea5...9f67075) [Compare Source](flow/flow-bin@80dcea5...9f67075) ### [`v0.219.2`](flow/flow-bin@c184c5d...80dcea5) [Compare Source](flow/flow-bin@c184c5d...80dcea5) </details> <details> <summary>quarkusio/quarkus</summary> ### [`v3.5.0`](https://github.com/quarkusio/quarkus/releases/tag/3.5.0) [Compare Source](quarkusio/quarkus@3.4.3...3.5.0) ##### Complete changelog - [#36527](quarkusio/quarkus#36527) - Start MongoDB 4.4 instead of 4.0 - [#36523](quarkusio/quarkus#36523) - Minor OIDC Auth0 updates - [#36518](quarkusio/quarkus#36518) - Allow for setting logging scope programmatically - [#36517](quarkusio/quarkus#36517) - Use Mandrel 23.1 in windows CI - [#36501](quarkusio/quarkus#36501) - Let custom OIDC token propagation filters customize the exchange status - [#36495](quarkusio/quarkus#36495) - Support external OTel exporters in CDI - [#36490](quarkusio/quarkus#36490) - Take ReaderInterceptor into account when reading SSE events - [#36487](quarkusio/quarkus#36487) - Upgrade to Liquibase 4.24.0 - [#36485](quarkusio/quarkus#36485) - Fix typo in gradle-tooling.adoc - [#36474](quarkusio/quarkus#36474) - Fix some issues in getting-started-dev-services - [#36465](quarkusio/quarkus#36465) - Be more consistent in guides when creating projects/adding extensions - [#36464](quarkusio/quarkus#36464) - HTTP reference guide - HTTP/2 section update, drop JDK 8 note - [#36459](quarkusio/quarkus#36459) - Let custom OIDC token propagation filters provide client name - [#36457](quarkusio/quarkus#36457) - Update builder images to jdk-21 - [#36453](quarkusio/quarkus#36453) - Upgrade Oracle JDBC driver to 23.3.0.23.09 - [#36452](quarkusio/quarkus#36452) - Fix doc extension-add.adoc - [#36451](quarkusio/quarkus#36451) - Adjust extension name for consistency with rest of Quarkus - [#36446](quarkusio/quarkus#36446) - Regression: Liquibase fails to migrate on Quarkus start, crashing the application - [#36445](quarkusio/quarkus#36445) - Updates to Infinispan 14.0.19.Final - [#36442](quarkusio/quarkus#36442) - Use default content type when X-SSE header not set - [#36436](quarkusio/quarkus#36436) - Upgrade to Hibernate ORM 6.2.13.Final - [#36432](quarkusio/quarkus#36432) - Hibernate Reactive Panache: improve error message - [#36420](quarkusio/quarkus#36420) - Allow parallel execution of blocking health checks - [#36419](quarkusio/quarkus#36419) - Blocking Health Checks should be executed in parallel, not sequentially/ordered - [#36417](quarkusio/quarkus#36417) - Reduce timeout of the doc build to 60 minutes - [#36413](quarkusio/quarkus#36413) - Simplify virtual threads guide by pushing users to 21 - [#36412](quarkusio/quarkus#36412) - Drop Optaplanner from the documentation - [#36411](quarkusio/quarkus#36411) - Drop panache topic from Hibernate Reactive guide - [#36410](quarkusio/quarkus#36410) - Add compatibility topic to Spring guides - [#36407](quarkusio/quarkus#36407) - Register RuntimeOverrideConfigSource in STATIC_INIT - [#36406](quarkusio/quarkus#36406) - AssembleDownstreamDocumentation - print guide name - [#36400](quarkusio/quarkus#36400) - Add topics and extensions metadata to guides - [#36367](quarkusio/quarkus#36367) - Bump org.wiremock:wiremock-standalone from 3.1.0 to 3.2.0 - [#36365](quarkusio/quarkus#36365) - Bump de.flapdoodle.embed:de.flapdoodle.embed.mongo from 4.7.0 to 4.9.2 - [#36360](quarkusio/quarkus#36360) - Drop the old Dev UI guide - [#36337](quarkusio/quarkus#36337) - Upgrade maven to version 3.9.5 - [#36236](quarkusio/quarkus#36236) - No Panache session in REST endpoints defined by an interface - [#35931](quarkusio/quarkus#35931) - Add OIDC Auth0 extended tutorial - [#33548](quarkusio/quarkus#33548) - Pick random debug port when the configured one is taken - [#33363](quarkusio/quarkus#33363) - allow quarkus dev to pick random debug port </details> <details> <summary>quarkusio/quarkus-platform</summary> ### [`v3.5.0`](quarkusio/quarkus-platform@3.4.3...3.5.0) [Compare Source](quarkusio/quarkus-platform@3.4.3...3.5.0) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever MR is behind base branch, or you tick the rebase/retry checkbox. 👻 **Immortal**: This MR will be recreated if closed unmerged. Get [config help](https://github.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

leo-bogastry added 2 commits October 12, 2023 16:49

Fix wrong text format

fc63e49

Fix error in command to add extension using quarkus cli

ae11836

quarkus-bot bot added area/docstyle issues related for manual docstyle review area/documentation labels Oct 12, 2023

gsmet requested changes Oct 12, 2023

View reviewed changes

gsmet reviewed Oct 12, 2023

View reviewed changes

gsmet approved these changes Oct 16, 2023

View reviewed changes

gsmet merged commit 1d4b927 into quarkusio:main Oct 16, 2023
5 checks passed

quarkus-bot bot added this to the 3.6 - main milestone Oct 16, 2023

gsmet added the triage/backport? label Oct 16, 2023

gsmet modified the milestones: 3.6 - main, 3.5.0 Oct 17, 2023

gsmet removed the triage/backport? label Oct 17, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix doc extension-add.adoc #36452

Fix doc extension-add.adoc #36452

leo-bogastry commented Oct 12, 2023

gsmet left a comment

gsmet Oct 12, 2023

gsmet Oct 12, 2023 •

edited

Loading

leo-bogastry Oct 13, 2023

gsmet Oct 12, 2023

github-actions bot commented Oct 12, 2023 •

edited

Loading

gsmet left a comment

Description	with quotes	without quotes
MacOs Sonoma: one extension	✅	✅
MacOs Sonoma: multiple extensions	❌	✅
Ubuntu 22.04.3: one extension	✅	✅
Ubuntu 22.04.3: multiple extensions	❌	✅
Windows command line: one extension	❌	✅
Windows command line: multiple extensions	❌	✅
Windows powershell: one extension	✅	✅
Windows powershell: multiple extensions	❌	✅

Fix doc extension-add.adoc #36452

Fix doc extension-add.adoc #36452

Conversation

leo-bogastry commented Oct 12, 2023

gsmet left a comment

Choose a reason for hiding this comment

gsmet Oct 12, 2023

Choose a reason for hiding this comment

gsmet Oct 12, 2023 • edited Loading

Choose a reason for hiding this comment

leo-bogastry Oct 13, 2023

Choose a reason for hiding this comment

gsmet Oct 12, 2023

Choose a reason for hiding this comment

github-actions bot commented Oct 12, 2023 • edited Loading

gsmet left a comment

Choose a reason for hiding this comment

gsmet Oct 12, 2023 •

edited

Loading

github-actions bot commented Oct 12, 2023 •

edited

Loading