Doc: Formatting fixes #115
Conversation
| @@ -54,7 +54,7 @@ Before upgrading this plugin or Logstash itself, please pay special attention to | |||
|
|
|||
| You will need to configure this plugin to connect to {es}, and may need to also need to provide local GeoIp databases. | |||
|
|
|||
| [source] | |||
| [source,ruby] | |||
There was a problem hiding this comment.
Required to make code sample render correctly
| :prohibit-ssl-disabled-explicit: Cannot be combined with `<<plugins-{type}s-{plugin}-ssl_enabled>>=>false`. | ||
| :prohibit-ssl-verify-none: Cannot be combined with `<<plugins-{type}s-{plugin}-ssl_verification_mode>>=>none`. |
There was a problem hiding this comment.
Reformatting to make link text literal
There was a problem hiding this comment.
This approach works, but I'm not convinced that it's best practice. This approach doesn't save us much time or repetition, yet puts added burden on a user looking at docs in the plugin repo.
Rather than clearly stating the information with the setting, we're giving users a job to do in order to go find where we set up these variables.
There was a problem hiding this comment.
I'd like to get the initial docs published soon, and I'm willing to table this for a later discussion outside of this PR.
|
@mashhurs The extra 
I'm guessing that you want these entries to be literal? For example (borrowed from screenshot): |
|
@mashhurs, please take a look and share your thoughts. When we're done, I'll bump versions and publish to get these docs building for the Logstash Reference. |
That's correct @karenzone ! Thank you for catching up. |
|
Thanks for the confirmation, @mashhurs. I'll fix it tomorrow. |
|
@mashhurs, new commits caused your review to be dismissed. Can I get a fresh LGTM, please? |
|
Published at v.0.1.3 |
Fixes: #82