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.

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

Add --with-codestart create-extension option to tutorial #28768

Merged
merged 1 commit into from Nov 15, 2022
Merged

Add --with-codestart create-extension option to tutorial #28768

merged 1 commit into from Nov 15, 2022

Conversation

joes
Copy link
Contributor

@joes joes commented Oct 23, 2022

Description

Document the option -DwithCodestart in the tutorial for generating new Codestart extensions.

Background
The option -DwithCodestart was provided in #26628 by @ia3andy but I did not see any documentation for it.

The tutorial suggests that the easiest way to create a codestart extension is by starting with a Quarkus project. However, with the addition of the -DwithCodestart option this is no longer the easiest way (imho) so I changed the wording in the tutorial wrt this to make it more neutral.

@quarkus-bot quarkus-bot bot added area/arc Issue related to ARC (dependency injection) area/dependencies Pull requests that update a dependency file area/devtools Issues/PR related to maven, gradle, platform and cli tooling/plugins area/graphql area/infra-automation anything related to CI, bots, etc. that are used to automated our infrastructure area/jakarta area/kubernetes area/qute The template engine area/smallrye area/testing labels Oct 24, 2022
@joes
Copy link
Contributor Author

joes commented Oct 24, 2022

Removed unneeded comment placeholders in the usage example

@gastaldi
Copy link
Contributor

That looks good to me. It would be nice to also document using the Quarkus CLI (which we highly recommend):

$ quarkus create extension greeting --codestart                 ✔
Looking for the newly published extensions in registry.quarkus.io

Detected layout type is 'quarkiverse'
Generated runtime artifactId is 'quarkus-greeting'


applying codestarts...
📚  java
🔨  maven
📦  quarkus-extension
🔧  git
🚀  devmode-test
🚀  extension-base
🚀  extension-codestart
🚀  integration-tests
🚀  quarkiverse
🚀  unit-test

-----------
 👍  extension has been successfully generated in:
--> /private/tmp/quarkus-greeting
-----------
Navigate into this directory and get started: quarkus build

@ia3andy
Copy link
Contributor

ia3andy commented Oct 25, 2022

Thanks @gastaldi for the review :)

@joes
Copy link
Contributor Author

joes commented Nov 12, 2022

I documented Quarkus CLI as suggested by you @gastaldi.

@gsmet gsmet requested a review from gastaldi November 15, 2022 10:17
Quarkus Documentation automation moved this from To do to Reviewer approved Nov 15, 2022
Copy link
Contributor

@gastaldi gastaldi left a comment

Choose a reason for hiding this comment

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

LGTM

@gsmet
Copy link
Member

gsmet commented Nov 15, 2022

@ia3andy could you have a look at this one?

Copy link
Contributor

@ia3andy ia3andy left a comment

Choose a reason for hiding this comment

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

LGTM

@ia3andy ia3andy merged commit 70c25ef into quarkusio:main Nov 15, 2022
Quarkus Documentation automation moved this from Reviewer approved to Done Nov 15, 2022
@quarkus-bot quarkus-bot bot added this to the 2.15 - main milestone Nov 15, 2022
@gsmet gsmet removed this from the 2.15 - main milestone Nov 15, 2022
@gsmet gsmet added this to the 2.14.1.Final milestone Nov 15, 2022
@joes
Copy link
Contributor Author

joes commented Nov 16, 2022

Thank you for all the input @gastaldi!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/arc Issue related to ARC (dependency injection) area/dependencies Pull requests that update a dependency file area/devtools Issues/PR related to maven, gradle, platform and cli tooling/plugins area/documentation area/graphql area/infra-automation anything related to CI, bots, etc. that are used to automated our infrastructure area/jakarta area/kubernetes area/qute The template engine area/smallrye area/testing
Development

Successfully merging this pull request may close these issues.

None yet

4 participants