Skip to content

Commit

Permalink
do not conflate quickstarts with codestarts
Browse files Browse the repository at this point in the history
  • Loading branch information
@maxandersen
maxandersen committed May 1, 2024
1 parent dfc948c commit 9e484f2
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/extension-codestart.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This guide explains how to create and configure a Quarkus Codestart for an exten

== Description

"Extension Codestarts" is the name we give to our Quarkus extension quickstart code generation system. It aims to provide a personalized getting started experience with Quarkus.
"Extension Codestarts" is the name we give to our Quarkus extension "getting started" code generation system. It aims to provide a personalized getting started experience with Quarkus.

Check warning on line 16 in docs/src/main/asciidoc/extension-codestart.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 'Codestarts'?

Raw Output:
{"message": "[Quarkus.Spelling] Use correct American English spelling. Did you really mean 'Codestarts'?", "location": {"path": "docs/src/main/asciidoc/extension-codestart.adoc", "range": {"start": {"line": 16, "column": 12}}}, "severity": "WARNING"}
A Quarkus extension is able to provide one or more well-defined codestarts which will contain the resources and code required/recommended to start using that particular extension.

Check warning on line 17 in docs/src/main/asciidoc/extension-codestart.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsSuggestions] Depending on the context, consider using ', which (non restrictive clause preceded by a comma)' or 'that (restrictive clause without a comma)' rather than 'which'.

Raw Output:
{"message": "[Quarkus.TermsSuggestions] Depending on the context, consider using ', which (non restrictive clause preceded by a comma)' or 'that (restrictive clause without a comma)' rather than 'which'.", "location": {"path": "docs/src/main/asciidoc/extension-codestart.adoc", "range": {"start": {"line": 17, "column": 75}}}, "severity": "INFO"}

Check warning on line 17 in docs/src/main/asciidoc/extension-codestart.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsSuggestions] Depending on the context, consider using 'by using' or 'that uses' rather than 'using'.

Raw Output:
{"message": "[Quarkus.TermsSuggestions] Depending on the context, consider using 'by using' or 'that uses' rather than 'using'.", "location": {"path": "docs/src/main/asciidoc/extension-codestart.adoc", "range": {"start": {"line": 17, "column": 147}}}, "severity": "INFO"}

Extension codestarts are applied by default when using the Quarkus tooling (if the chosen extensions contain any):

Check warning on line 19 in docs/src/main/asciidoc/extension-codestart.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 'codestarts'?

Raw Output:
{"message": "[Quarkus.Spelling] Use correct American English spelling. Did you really mean 'codestarts'?", "location": {"path": "docs/src/main/asciidoc/extension-codestart.adoc", "range": {"start": {"line": 19, "column": 11}}}, "severity": "WARNING"}

Check warning on line 19 in docs/src/main/asciidoc/extension-codestart.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsSuggestions] Depending on the context, consider using 'by using' or 'that uses' rather than 'using'.

Raw Output:
{"message": "[Quarkus.TermsSuggestions] Depending on the context, consider using 'by using' or 'that uses' rather than 'using'.", "location": {"path": "docs/src/main/asciidoc/extension-codestart.adoc", "range": {"start": {"line": 19, "column": 49}}}, "severity": "INFO"}
Expand Down

0 comments on commit 9e484f2

Please sign in to comment.