Various documentation fixes #666
Conversation
…with docker (sounds obvious)
…variables are not substituted
…lity This is related to #543
| hello shamrock! | ||
| ---- | ||
|
|
||
| TIP: If the application requires configuration values and these values are not set, an error is thrown. |
There was a problem hiding this comment.
A TIP admonition would make sense?
There was a problem hiding this comment.
it's already an admonition (single line admonition).
Admonition blocks are supported too and allows adding title and paragraph as content. However, for short notes like this one I've found single-line more readable.
|
|
||
| As usual, the application can be packaged using `mvn clean package` and executed using the `-runner.jar` file. | ||
| You can also generate the native executable. | ||
| You can also generate the native executable with `mvn clean package -Pnative` |
There was a problem hiding this comment.
Not related to this patch but maybe we should be consistent with what we do in Shamrock proper and use -Dnative. We would need the profile to be activated on the property.
Not sure it's worth the work though. In any case, if we decide to do it, let's do it in a follow-up PR (and update all the guides).
There was a problem hiding this comment.
I tend to prefer specifying profiles explicitly, at least for the users. Now, if the user is a Maven user, he can definitely change that.
But we can change the behavior (it would require changing the template, doc, and quickstarts).
| ==== | ||
| The events are also called in _dev mode_ between each redeployment. | ||
| ==== | ||
| TIP: The events are also called in _dev mode_ between each redeployment. |
There was a problem hiding this comment.
Oh, one line admonitions are supported this way?
There was a problem hiding this comment.
| hello shamrock! | ||
| ---- | ||
|
|
||
| TIP: If the application requires configuration values and these values are not set, an error is thrown. |
There was a problem hiding this comment.
it's already an admonition (single line admonition).
Admonition blocks are supported too and allows adding title and paragraph as content. However, for short notes like this one I've found single-line more readable.
|
|
||
| As usual, the application can be packaged using `mvn clean package` and executed using the `-runner.jar` file. | ||
| You can also generate the native executable. | ||
| You can also generate the native executable with `mvn clean package -Pnative` |
There was a problem hiding this comment.
I tend to prefer specifying profiles explicitly, at least for the users. Now, if the user is a Maven user, he can definitely change that.
But we can change the behavior (it would require changing the template, doc, and quickstarts).
| ==== | ||
| The events are also called in _dev mode_ between each redeployment. | ||
| ==== | ||
| TIP: The events are also called in _dev mode_ between each redeployment. |
There was a problem hiding this comment.
|
|
||
| In your favorite IDE, create a new Maven project. | ||
| It should generate a `pom.xml` file with a content similar to: | ||
| The easiest way to create a new Protean project is to open a terminal and run the following command: |
There was a problem hiding this comment.
Sorry, missed that on the first review, but Protean should be {project-name}. We use that consistently in the docs.
There was a problem hiding this comment.
Have you pushed your changes? It still appears as "Protean" on GitHub?
There was a problem hiding this comment.
well... pushed on the wrong remote. Will cleanup once merged.
There was a problem hiding this comment.
should be better now.
* use {project-name} instead of Protean
* rephrase the part on junit 5 and surefire
|
I've fixed all of them! Thanks! |
Co-authored-by: Stuart Douglas <[email protected]>
2 participants
extensions.jsonlocation (was not filtered)