docs(mailer): document ssl enablement in native image #3224
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gsmet
reviewed
Jul 15, 2019
| @@ -75,7 +75,7 @@ The following table lists the properties that can be configured: | |||
| | port | Integer | the SMTP server port | `25` | |||
| | username | String | the username | | |||
| | password | String | the password | | |||
| | ssl | Boolean | Enables or disables SSL | `false` | |||
| | ssl | Boolean | Enables or disables SSL. When enabled, you must add `quarkus.ssl.native=true` config option in `application.properties` when building a native image. | `false` | |||
There was a problem hiding this comment.
I would just say: "If enabled, you must also set quarkus.ssl.native to true when building a native image.".
You are already in the config context so I don't think we need more precision. I think I would also add a link to the SSL + native image guide (More information).
There was a problem hiding this comment.
A link is definitely needed. I’ll add it and push. Thanks.
There was a problem hiding this comment.
Maybe you can just add the link on set quarkus.ssl.native to true. It will be shorter.
gsmet
reviewed
Jul 15, 2019
| @@ -75,7 +75,7 @@ The following table lists the properties that can be configured: | |||
| | port | Integer | the SMTP server port | `25` | |||
| | username | String | the username | | |||
| | password | String | the password | | |||
| | ssl | Boolean | Enables or disables SSL | `false` | |||
| | ssl | Boolean | Enables or disables SSL. If enabled, you must also link:native-and-ssl-guide.html[set quarkus.ssl.native to true] when building a native image. | `false` | |||
There was a problem hiding this comment.
It's minor but having backticks around quarkus.ssl.native would be nice
There was a problem hiding this comment.
Good catch. Should be good. :-)
gsmet
approved these changes
Jul 15, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #3221