kibana
kibana copied to clipboard
[Docs test] Config settings mock-up
Summary
Please don't merge!
This is a mock-up of how a list of Kibana settings can be rendered in Asciidoc from a YAML source file (kibana-config-settings.yml
) that contains a list of all public Kibana configuration settings and their properties.
-
kibana-config-settings.yml
→ Perl script:perl parse-settings.pl
→kibana-config-settings.asciidoc
(contains Asciidoc-formatted settings snippets). -
alert-action-settings-new.asciidoc
(replacing the originalalert-action-settings.asciidoc
content with simpleinclude
statements) pulls in those snippets, and from that source file we generate the HTML public docs.
Note: If you want to run the Perl script you need to update the variables at lines 18 and 19 to your local path. For example:
my $sourcedir = '/Users/kilfoyle/repos/kibana/docs/settings-gen/source';
my $asciidocdir = '/Users/kilfoyle/repos/kibana/docs/settings-gen/source/';
Rel: https://github.com/elastic/docs-projects/issues/239
How these files fit together