Change titles in config reference topics #1885
Conversation
|
|
||
| You can specify configuration options that control Filebeat behavior at a global level. | ||
|
|
||
| ==== Options |
There was a problem hiding this comment.
I assume we need this title here, because asciidoc does not allow leaving it out?
There was a problem hiding this comment.
@ruflin It's not exactly an asciidoc issue. In most cases, we could remove this heading and move everything up a level, but then we'd get inconsistent formatting for options because in some places we break the options down into further categories. I think it's better to keep all the options at the same heading level so that they appear consistent across the doc (same formatting, etc), and so that you don't get a long list of options under the "On this page" area above the navigation.
|
LGTM. I left some minor comments. We should defintively rename shipperconfig to prevent confusion. |
dedemorton
force-pushed
the
beats_issue#1792
branch
from
42e5cda to
4e12bca
Compare
|
@ruflin I've updated the docs to reflect your feedback. This PR should be ready to merge if my changes look OK to you. |
|
@dedemorton I merged it as is. About the run options: the file should probably be moved into the packetbeat docs folder. |
This PR resolves issue #1792
Section titles are renamed to match the section comments in the long version of each config file (hopefully making it easier for users to find what they're looking for in the reference docs).
Some content has been moved around to better match the organization of the config files.