Doc: Little rework of DevUi documentation #39235
Conversation
Status for workflow
|
|
🙈 The PR is closed and the preview is expired. |
|
|
||
| image::dev-ui-overview-v2.png[alt=Dev UI overview,role="center"] | ||
| When you start quarkus with `mvn quarkus:dev` the Dev ui is available at http://localhost:8080/q/dev-ui[/q/dev-ui] by default. |
There was a problem hiding this comment.
| When you start quarkus with `mvn quarkus:dev` the Dev ui is available at http://localhost:8080/q/dev-ui[/q/dev-ui] by default. | |
| When you start Quarkus with `mvn quarkus:dev` the Dev UI is available at http://localhost:8080/q/dev-ui[/q/dev-ui] by default. |
| - view and change `Configuration` | ||
| - manage and visualize `Continuous Testing` | ||
| - view `Dev Services` information | ||
| - view the Build information | ||
| - view and stream various logs | ||
|
|
||
|
|
||
| _In de prod QUARKUS_PROFILE the Dev ui is not available, see the documentation on how https://quarkus.io/guides/config-reference#default-profiles[configure it]_ |
There was a problem hiding this comment.
I'm not sure what you're trying to say here? We already state previously that the Dev UI is available in dev mode.
Also this guide is for extension authors, not for general considerations about the Dev UI.
| @@ -15,37 +15,45 @@ include::_attributes.adoc[] | |||
| This guide covers the Dev UI v2, which is the default from Quarkus 3 onwards. | |||
| ==== | |||
|
|
|||
| This guide covers the Quarkus Dev UI for xref:building-my-first-extension.adoc[extension authors]. | |||
There was a problem hiding this comment.
This sentence is very important and should stay at the top.
This guide is for extension developers.
I think what actually needs an adjustment is the title of the guide.
For the rest, I think I prefer the current content to your proposal as this guide has a very precise purpose and is not a general Dev UI guide.
There was a problem hiding this comment.
Thank you for your dedication and the effort you've put into your contributions, @allemas. After careful consideration, it appears that the reviewer has decided to maintain the existing content as it closely aligns with our current goals and guidelines. Therefore, it looks like we'll be closing this PR. However, your input is highly valued, and I plan to initiate a follow-up PR to update the title, incorporating aspects of your suggestions where applicable. We genuinely appreciate your understanding and look forward to your continued contributions to our project.
Little improvement in Dev Ui documentation.
As discussed here I struggled to understand devui isn't launched with prod QUARKUS_PROFILE #39027
The idea is to be more clear and not lost the user with extensions implementations details.
Open to any suggestions, hope this help.