Minor fixes to attributes in module docs #7949
Conversation
dedemorton
added
docs
needs_backport
|
|
||
| include::../include/var-paths.asciidoc[] | ||
|
|
||
| :fileset_ex!: |
There was a problem hiding this comment.
@dedemorton What does this actually do? It doesn't seem to be having any visible effect in the generated HTML that I'm seeing:
There was a problem hiding this comment.
@ycombinator It clears the attribute value so that it doesn't inadvertently get carried into the next topic. The attribute value will be in scope within the book until it's either cleared or reset, so clearing the value is a best practice unless you want to value to exist in other topics (and in this case, you do not).
There was a problem hiding this comment.
Gotcha, thanks for explaining that. From what I see, after that attribute is set on line 27, it is used by the included file on line 29 (config-option-intro.asciidoc). It is not, however, used by the included file on line 34 (var-paths.asciidoc). So does it make sense to clear the attribute right after line 29?
I'm referencing line numbers in the generated asciidoc file here, but I understand that the actual changes would happen in the filebeat/module/kibana/_meta/docs.asciidoc file, where the line numbers are different.
There was a problem hiding this comment.
I don't think it really matters. Clearing everything at the end is probably easier for people updating the files (they are less likely to accidentally delete the entries...maybe).
There was a problem hiding this comment.
Yeah, fair point. I see you're doing that with modulename too. I'm good with keeping things as-is.
|
@dedemorton I added the |
dedemorton
removed
the
needs_backport
…7937 #7939 #7948 #7949 #7950) (#8188) * Reset modulename attribute at the end of a file (#7888) * Add safeguard related statements for max_backoff setting (#7889) * Add docs about append_fields (#7903) * Add docs about append_fields * Remove experimental tag from setup.template.json.enabled description * Metricbeat: Add compatibility notes where missing (#7939) * Metricbeat: Add compatibility notes where missing, based on integration tests * Added review suggestions * Add missing config options to Logstash section of reference.yml (#7883) Closes #3062 * Fix processor autodiscovery docs for Filebeat (#7937) { needs escaping as otherwise asciidoc will show an empty code block. * Add document for beat export dashboard (#7696) * Add document for beat export dashboard Follow up from #7239 * move to command reference * address review comments * review comments applied * apply review feedback * Replace golang with Go (#7948) I've been told that using "golang" instead of "Go" is considered a faux pas in some circles. :-) I've replaced instances in the external docs, but I did not update the changelog, readmes, or code files. * Minor fixes to attributes in module docs (#7949) * Add recommendation to avoid harvesting symlinks when dealing with file rotation (#7950)
…tic#7903 elastic#7937 elastic#7949) (elastic#7996) * Add document for beat export dashboard (elastic#7696) * Add safeguard related statements for max_backoff setting (elastic#7889) * Add docs about append_fields (elastic#7903) * Fix processor autodiscovery docs for Filebeat (elastic#7937) * Minor fixes to attributes in module docs (elastic#7949)
{fileset}should have been replaced bylog, but wasn't, so it was showing up in the output.Also clarified the usage of
fileset_exattribute.