Remove comments from config example code #2513
Merged
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
| # The tags of the shipper are included in their own field with each | ||
| # transaction published. Tags make it easy to group servers by different | ||
| # logical properties. | ||
| name: "my-shipper" |
There was a problem hiding this comment.
Would prefer to not have shipper here but don't have a good alternative.
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.
Removes comments from config example code (as described in issue #1795 and tracked by issue #2484).
This change makes the config examples a lot easier to scan, and makes it easier for us to keep the config examples in sync with the .yml config files.
The description of each option should provide any info that was available in the comment. If it doesn't, let me know so I can add more info to the description. This is also a good opportunity to scan the config examples for any old settings or configs that we don't recommend anymore. :-)
Note that I didn't remove comments from the Metricbeat config examples because they are generated. @ruflin I think it's OK if we can't modify the doc generator to remove comments because having the examples generated is a big plus IMHO.
Also made some minor tweaks, like removing unnecessary quotation marks.