From 70d2476280a0f5937b16c7482af6ae3bbf791977 Mon Sep 17 00:00:00 2001 From: lcawl Date: Mon, 20 Jan 2025 19:20:45 -0800 Subject: [PATCH 1/7] Draft placeholders for overview pages --- docs/source/docset.yml | 18 ++++++++++++++++++ docs/source/reference-overview/index.md | 5 +++++ .../reference-overview/kibana/overview.md | 15 +++++++++++++++ 3 files changed, 38 insertions(+) create mode 100644 docs/source/reference-overview/index.md create mode 100644 docs/source/reference-overview/kibana/overview.md diff --git a/docs/source/docset.yml b/docs/source/docset.yml index 7ff9426..c024fd2 100644 --- a/docs/source/docset.yml +++ b/docs/source/docset.yml @@ -46,3 +46,21 @@ toc: - folder: content - file: index.md - folder: versioning + - folder: reference-overview + children: + - file: index.md + - folder: security + - folder: observability + - folder: search + - folder: elasticsearch + - folder: ingest + - file: kibana/overview.md + children: + - file: kibana/settings.md + - folder: elasticsearch-plugins + - folder: query-languages + - folder: scripting-languages + - folder: ecs + - folder: data-analysis + - folder: cloud + - folder: glossary \ No newline at end of file diff --git a/docs/source/reference-overview/index.md b/docs/source/reference-overview/index.md new file mode 100644 index 0000000..00a841c --- /dev/null +++ b/docs/source/reference-overview/index.md @@ -0,0 +1,5 @@ +--- +title: Reference +--- + +This is a placeholder for the top-level reference overview. diff --git a/docs/source/reference-overview/kibana/overview.md b/docs/source/reference-overview/kibana/overview.md new file mode 100644 index 0000000..f930462 --- /dev/null +++ b/docs/source/reference-overview/kibana/overview.md @@ -0,0 +1,15 @@ +--- +title: Kibana Reference +navigation_title: "Kibana" +--- + +% TO-DO: Add links to "What is Kibana?"% + +This section of the documentation contains reference information for Kibana apps and Elastic Cloud Serverless management features, including: + +* Settings +* Audit events +* Connectors +* Plugins +* Command line tools +* Osquery fields and packs \ No newline at end of file From c536c9aaa3643aa60ce871cfc6b1e13670cada2d Mon Sep 17 00:00:00 2001 From: lcawl Date: Mon, 20 Jan 2025 19:38:03 -0800 Subject: [PATCH 2/7] Add settings list --- .../reference-overview/kibana/settings.md | 31 +++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 docs/source/reference-overview/kibana/settings.md diff --git a/docs/source/reference-overview/kibana/settings.md b/docs/source/reference-overview/kibana/settings.md new file mode 100644 index 0000000..23c9b3c --- /dev/null +++ b/docs/source/reference-overview/kibana/settings.md @@ -0,0 +1,31 @@ +--- +title: Kibana settings +navigation_title: "Settings" +--- + +Configuration settings enable you to customize the behavior of Kibana apps and features. +This reference provides details about each setting, such as its purpose, default behavior, and availability in Elastic Cloud environments. + +% TO-DO: For information about how to update these settings, refer to "Configure Kibana" (link to appropriate deployment pages) % + +The settings are grouped by feature or purpose, for example: + +- AI Assistant +- Alerting +- APM +- Banners +- Cases +- Enterprise Search +- Fleet +- Internationalization +- Logging +- Logs +- Metrics +- Monitoring +- Reporting +- Search sessions +- Security +- Spaces +- Task Manager +- Telemetry +- URL drilldown \ No newline at end of file From cec9e357a1fa8ebbc9c69660a46df747faffd9ec Mon Sep 17 00:00:00 2001 From: lcawl Date: Mon, 20 Jan 2025 19:44:21 -0800 Subject: [PATCH 3/7] Remove empty folders for build error --- docs/source/docset.yml | 14 +------------- 1 file changed, 1 insertion(+), 13 deletions(-) diff --git a/docs/source/docset.yml b/docs/source/docset.yml index c024fd2..c9c3b3e 100644 --- a/docs/source/docset.yml +++ b/docs/source/docset.yml @@ -49,18 +49,6 @@ toc: - folder: reference-overview children: - file: index.md - - folder: security - - folder: observability - - folder: search - - folder: elasticsearch - - folder: ingest - file: kibana/overview.md children: - - file: kibana/settings.md - - folder: elasticsearch-plugins - - folder: query-languages - - folder: scripting-languages - - folder: ecs - - folder: data-analysis - - folder: cloud - - folder: glossary \ No newline at end of file + - file: kibana/settings.md \ No newline at end of file From c74398e0e84b35374facf76a07025207e75b4631 Mon Sep 17 00:00:00 2001 From: lcawl Date: Mon, 20 Jan 2025 19:48:27 -0800 Subject: [PATCH 4/7] Comment out failure --- docs/source/markup/admonitions.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/source/markup/admonitions.md b/docs/source/markup/admonitions.md index 0184c4a..ebd6d2d 100644 --- a/docs/source/markup/admonitions.md +++ b/docs/source/markup/admonitions.md @@ -60,4 +60,5 @@ Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor i ## Link to admonitions You can add a 'name' option to an admonition, so that you can link to it elsewhere -Here is a [link to attention](#caution_ref) +%Commented out failing admonition +%Here is a [link to attention](#caution_ref) From 2aa33784f2b88ea31b0733b986956249f80f726b Mon Sep 17 00:00:00 2001 From: lcawl Date: Mon, 20 Jan 2025 19:50:28 -0800 Subject: [PATCH 5/7] More admonition cleanup --- docs/source/markup/admonitions.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/source/markup/admonitions.md b/docs/source/markup/admonitions.md index ebd6d2d..81b04f4 100644 --- a/docs/source/markup/admonitions.md +++ b/docs/source/markup/admonitions.md @@ -60,5 +60,3 @@ Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor i ## Link to admonitions You can add a 'name' option to an admonition, so that you can link to it elsewhere -%Commented out failing admonition -%Here is a [link to attention](#caution_ref) From f62eed03fb88f56e2c97b4a4eff32a579612cc81 Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 21 Jan 2025 18:40:29 -0800 Subject: [PATCH 6/7] Collapse kibana reference folder --- docs/source/docset.yml | 4 ++-- .../{kibana/settings.md => kibana-configuration.md} | 4 ++-- .../{kibana/overview.md => kibana-reference.md} | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) rename docs/source/reference-overview/{kibana/settings.md => kibana-configuration.md} (89%) rename docs/source/reference-overview/{kibana/overview.md => kibana-reference.md} (92%) diff --git a/docs/source/docset.yml b/docs/source/docset.yml index c9c3b3e..7e5fffc 100644 --- a/docs/source/docset.yml +++ b/docs/source/docset.yml @@ -49,6 +49,6 @@ toc: - folder: reference-overview children: - file: index.md - - file: kibana/overview.md + - file: kibana-reference.md children: - - file: kibana/settings.md \ No newline at end of file + - file: kibana-configuration.md \ No newline at end of file diff --git a/docs/source/reference-overview/kibana/settings.md b/docs/source/reference-overview/kibana-configuration.md similarity index 89% rename from docs/source/reference-overview/kibana/settings.md rename to docs/source/reference-overview/kibana-configuration.md index 23c9b3c..14fd50d 100644 --- a/docs/source/reference-overview/kibana/settings.md +++ b/docs/source/reference-overview/kibana-configuration.md @@ -1,6 +1,6 @@ --- -title: Kibana settings -navigation_title: "Settings" +title: Kibana configuration reference +navigation_title: "Configuration reference" --- Configuration settings enable you to customize the behavior of Kibana apps and features. diff --git a/docs/source/reference-overview/kibana/overview.md b/docs/source/reference-overview/kibana-reference.md similarity index 92% rename from docs/source/reference-overview/kibana/overview.md rename to docs/source/reference-overview/kibana-reference.md index f930462..36a056f 100644 --- a/docs/source/reference-overview/kibana/overview.md +++ b/docs/source/reference-overview/kibana-reference.md @@ -1,5 +1,5 @@ --- -title: Kibana Reference +title: Kibana reference navigation_title: "Kibana" --- From 597ffa742ce53d0ac4bcc81031dbbd15d220b04d Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Wed, 22 Jan 2025 09:31:30 -0800 Subject: [PATCH 7/7] Update docs/source/reference-overview/kibana-reference.md Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com> --- docs/source/reference-overview/kibana-reference.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/reference-overview/kibana-reference.md b/docs/source/reference-overview/kibana-reference.md index 36a056f..3b8098b 100644 --- a/docs/source/reference-overview/kibana-reference.md +++ b/docs/source/reference-overview/kibana-reference.md @@ -5,7 +5,7 @@ navigation_title: "Kibana" % TO-DO: Add links to "What is Kibana?"% -This section of the documentation contains reference information for Kibana apps and Elastic Cloud Serverless management features, including: +This section contains reference information for Kibana apps and Elastic Cloud Serverless management features, including: * Settings * Audit events