Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix doc extension-add.adoc #36452

Merged
merged 2 commits into from
Oct 16, 2023
Merged

Fix doc extension-add.adoc #36452

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fc63e49
Fix wrong text format
leo-bogastry Oct 12, 2023
ae11836
Fix error in command to add extension using quarkus cli
leo-bogastry Oct 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/_includes/devtools/extension-add.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Copy link
Member

@gsmet gsmet Oct 12, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

----
ifndef::devtools-no-maven[]
ifdef::devtools-wrapped[+]
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/getting-started-dev-services.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,10 +79,10 @@
=== 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`

Check warning on line 82 in docs/src/main/asciidoc/getting-started-dev-services.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsSuggestions] Depending on the context, consider using '"click", "select", "browse", or "go to"' rather than 'navigate'.

Raw Output:
{"message": "[Quarkus.TermsSuggestions] Depending on the context, consider using '\"click\", \"select\", \"browse\", or \"go to\"' rather than 'navigate'.", "location": {"path": "docs/src/main/asciidoc/getting-started-dev-services.adoc", "range": {"start": {"line": 82, "column": 29}}}, "severity": "INFO"}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, we will get this in anyway!

Add a query param in the `hello` method.

Check warning on line 83 in docs/src/main/asciidoc/getting-started-dev-services.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.Spelling] Use correct American English spelling. Did you really mean 'param'?

Raw Output:
{"message": "[Quarkus.Spelling] Use correct American English spelling. Did you really mean 'param'?", "location": {"path": "docs/src/main/asciidoc/getting-started-dev-services.adoc", "range": {"start": {"line": 83, "column": 8}}}, "severity": "WARNING"}
(The `org.jboss.resteasy.reactive.RestQuery` annotation is like the Jakarta REST `@QueryParam`
annotation, except you don't need to duplicate the parameter name.)

Check warning on line 85 in docs/src/main/asciidoc/getting-started-dev-services.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.Fluff] Depending on the context, consider using 'Rewrite the sentence, or use 'must', instead of' rather than 'need to'.

Raw Output:
{"message": "[Quarkus.Fluff] Depending on the context, consider using 'Rewrite the sentence, or use 'must', instead of' rather than 'need to'.", "location": {"path": "docs/src/main/asciidoc/getting-started-dev-services.adoc", "range": {"start": {"line": 85, "column": 25}}}, "severity": "INFO"}

[source, java]
----
Expand Down