Skip to content

Commit

Permalink
Review comments from Guillaume
Browse files Browse the repository at this point in the history
  • Loading branch information
@holly-cummins
holly-cummins committed Aug 14, 2024
1 parent 789d480 commit b9c73fc
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/src/main/asciidoc/extension-writing-dev-service.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ include::_attributes.adoc[]
- You should already have an xref:building-my-first-extension.adoc[extension structure] in place
- You should have a containerised version of your external service (not all dev services rely on containers, but most do)

== Creating a dev service
== Creating a Dev Service

Check warning on line 21 in docs/src/main/asciidoc/extension-writing-dev-service.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.Headings] Use sentence-style capitalization in 'Creating a Dev Service'.

Raw Output:
{"message": "[Quarkus.Headings] Use sentence-style capitalization in 'Creating a Dev Service'.", "location": {"path": "docs/src/main/asciidoc/extension-writing-dev-service.adoc", "range": {"start": {"line": 21, "column": 4}}}, "severity": "INFO"}

If your extension provides APIs for connecting to an external service, it's a good idea to provide a xref:dev-services.adoc[dev service] implementation.

Expand Down Expand Up @@ -104,7 +104,7 @@ You may wish to use this config to set a fixed port, or set an image name, for e

== Controlling re-use

In dev mode, with hot reload, Quarkus may restart frequently. By default, this will also restart test containers.
In dev mode, with live reload, Quarkus may restart frequently. By default, this will also restart test containers.

Check warning on line 107 in docs/src/main/asciidoc/extension-writing-dev-service.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsWarnings] Consider using 'might (for possiblity)' or 'can (for ability)' rather than 'may' unless updating existing content that uses the term.

Raw Output:
{"message": "[Quarkus.TermsWarnings] Consider using 'might (for possiblity)' or 'can (for ability)' rather than 'may' unless updating existing content that uses the term.", "location": {"path": "docs/src/main/asciidoc/extension-writing-dev-service.adoc", "range": {"start": {"line": 107, "column": 40}}}, "severity": "WARNING"}
Quarkus restarts are usually very fast, but containers may take much longer to restart.

Check warning on line 108 in docs/src/main/asciidoc/extension-writing-dev-service.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsWarnings] Consider using 'might (for possiblity)' or 'can (for ability)' rather than 'may' unless updating existing content that uses the term.

Raw Output:
{"message": "[Quarkus.TermsWarnings] Consider using 'might (for possiblity)' or 'can (for ability)' rather than 'may' unless updating existing content that uses the term.", "location": {"path": "docs/src/main/asciidoc/extension-writing-dev-service.adoc", "range": {"start": {"line": 108, "column": 56}}}, "severity": "WARNING"}
To prevent containers restarting on every code change, you can mark the container as reusable:

Check warning on line 109 in docs/src/main/asciidoc/extension-writing-dev-service.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

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

Raw Output:
{"message": "[Quarkus.TermsSuggestions] Depending on the context, consider using 'because' or 'while' rather than 'as'.", "location": {"path": "docs/src/main/asciidoc/extension-writing-dev-service.adoc", "range": {"start": {"line": 109, "column": 83}}}, "severity": "INFO"}

Expand Down

0 comments on commit b9c73fc

Please sign in to comment.