Fix code format and missing dep on "writing a dev service" page #45703
Conversation
This comment was marked as resolved.
This comment was marked as resolved.
|
🎊 PR Preview 9104473 has been successfully built and deployed to https://quarkus-pr-main-45703-preview.surge.sh/version/main/guides/
|
This comment has been minimized.
This comment has been minimized.
ibethus
force-pushed
the
fix-doc-writing-dev-service
branch
2 times, most recently
from
6102ddc to
b455c92
Compare
* Fix code formating in code blocks * Add a section about the required dependency for writing a dev service
ibethus
force-pushed
the
fix-doc-writing-dev-service
branch
from
b455c92 to
e8728fe
Compare
ibethus
changed the title
Status for workflow
|
| @@ -5,118 +5,149 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc | |||
| //// | |||
| [id="extension-writing-dev-service"] | |||
| = Writing a Dev Service | |||
|
|
|||
There was a problem hiding this comment.
Please don't do that, I know it's not pretty but you can't have nice new lines or these attributes won't be considered document attributes.
| 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. | ||
| If your extension provides APIs for connecting to an external service, it's a good idea to provide a dev service implementation. | ||
|
|
||
| First, you must add the following dependency to your build file : |
There was a problem hiding this comment.
I think we need to be more precise here. It has to be added to the build part of the deployment module.
There was a problem hiding this comment.
| First, you must add the following dependency to your build file : | |
| First, you must add the following dependency to the build file, in your xref:writing-extensions.adoc#project-setup[deployement] module : |
| @BuildStep(onlyIfNot = IsNormal.class, onlyIf = GlobalDevServicesConfig.Enabled.class) | ||
| public DevServicesResultBuildItem createContainer() { | ||
| DockerImageName dockerImageName = DockerImageName.parse("hello-world"); | ||
| GenericContainer container = new GenericContainer<>(dockerImageName) | ||
| .withExposedPorts(SERVICE_PORT, OTHER_SERVICE_PORT) | ||
| .waitingFor(Wait.forLogMessage(".*" + "Started" + ".*", 1)) | ||
| .withReuse(true); |
There was a problem hiding this comment.
I think it was done this way to be clear it was a method of a class.
I'm not sure what's best really so I'm not asking you to change it, just stating the why.
| .waitingFor(Wait.forLogMessage(".*" + "Started" + ".*", 1)) | ||
| .waitingFor(Wait.forLogMessage(".*Started.*", 1)) |
There was a problem hiding this comment.
I wonder if we should cite the whole constructor call instead so that's it's extra clear? With this on a new line. WDYT?
There was a problem hiding this comment.
What about just reusing the containervariable we defined earlier ?
Something like container.waitingFor(Wait.forLogMessage(".*Started.*", 1)); for instance ?
I would also change the withReuse() example accordingly.
| .withReuse(true) | ||
| .withReuse(true) |
There was a problem hiding this comment.
Here I would also add a bit more context.
Any comment is welcome 😃