Skip to content

[Auditbeat] Enable system module docs #9670

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cwurm merged 2 commits into from
Dec 19, 2018
Merged

[Auditbeat] Enable system module docs #9670

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ca5d5d4
Enable Auditbeat system module docs.
Dec 19, 2018
011f5a8
Update docs
Dec 19, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions auditbeat/docs/modules_list.asciidoc
View file
Open in desktop
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
View file
Open in desktop
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
Copy link
Copy Markdown
Contributor

@webmat webmat Dec 19, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You did remove it at the earliest possible time! 💯

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