Improve generated documentation #6037
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 Filebeat module all docs follow the same template. This updates the generated docs to contain this template and mark the section that need work as TODOs.
|
@dedemorton You review on this one would be appreciated. |
dedemorton
suggested changes
Jan 10, 2018
| include::../include/configuring-intro.asciidoc[] | ||
|
|
||
| TODO: provide an example configuration | ||
|
|
There was a problem hiding this comment.
There's an example in config-option-intro.asciidoc that uses the fileset_ex attribute to resolve a fileset name:
TIP: When you specify a setting at the command line, remember to prefix the
setting with the module name, for example, +{modulename}.{fileset_ex}.var.paths+
instead of +{fileset_ex}.var.paths+.
So...I would add a TODO item before line 54. Something like:
TODO: Set the fileset_ex attribute to the name of any fileset in your module. For example:
:fileset_ex: access
|
|
||
| include::../include/config-option-intro.asciidoc[] | ||
|
|
||
| TODO: document: fileset variables |
There was a problem hiding this comment.
Should we expand the instructions here and provide an example? Or will that confuse users? If you think this would be confusing to module developers, we can provide feedback when the module is submitted for review.
TODO: document: fileset variables. If you're describing a variable that's common to other modules, you
can reuse shared descriptions by including the relevant file. For example:
[float]
==== `access` log fileset settings
include::../include/var-paths.asciidoc[]
|
@dedemorton While addressing your comments I realised that I can also make use of the |
ruflin
added
Filebeat
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.
The Filebeat module all docs follow the same template. This updates
the generated docs to contain this template and mark the section that
need work as TODOs.