Skip to content

Commit

Permalink
[Auditbeat] Cherry-pick #9670 to 6.x: Enable system module docs (#9716)
Browse files Browse the repository at this point in the history
Cherry-pick of PR #9670 to 6.x branch. Original message: 

With elastic/docs#512 merged we can enable links to `x-pack/auditbeat/docs` to have the system module included in the documentation.
  • Loading branch information
Christoph Wurm authored Dec 20, 2018
1 parent 5a30d96 commit 0c510a0
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 10 deletions.
2 changes: 2 additions & 0 deletions auditbeat/docs/modules_list.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@ This file is generated! See scripts/docs_collector.py

* <<{beatname_lc}-module-auditd,Auditd>>
* <<{beatname_lc}-module-file_integrity,File Integrity>>
* <<{beatname_lc}-module-system,System>>


--

include::./modules/auditd.asciidoc[]
include::./modules/file_integrity.asciidoc[]
include::../../x-pack/auditbeat/docs/modules/system.asciidoc[]
10 changes: 0 additions & 10 deletions auditbeat/scripts/docs_collector.py
Original file line number Diff line number Diff line change
Expand Up @@ -153,20 +153,10 @@ def collect(base_paths):

module_list_output = generated_note
for m, title in sorted(six.iteritems(modules_list)):
if m == "system":
# This is a very crude way of excluding references to X-Pack docs from
# the build until the docs build is updated with the new folder.
# TODO: Remove at the earliest possible time.
continue
module_list_output += " * <<{beatname_lc}-module-" + m + "," + title + ">>\n"

module_list_output += "\n\n--\n\n"
for module_name, module_path in sorted(six.iteritems(module_dirs)):
if module_name == "system":
# This is a very crude way of excluding references to X-Pack docs from
# the build until the docs build is updated with the new folder.
# TODO: Remove at the earliest possible time.
continue
rel_path_to_module_docs = os.path.relpath(module_docs_path(module_path), docs_path)
module_list_output += "include::" + \
os.path.join(rel_path_to_module_docs, "modules", module_name + ".asciidoc") + "[]\n"
Expand Down

0 comments on commit 0c510a0

Please sign in to comment.