From 23b4075cc3674e78baad50781aa2697b362b4325 Mon Sep 17 00:00:00 2001 From: Benjamin Ironside Goldstein Date: Tue, 23 Jul 2024 13:27:30 -0700 Subject: [PATCH 1/5] Preps getting started section for automatic import doc --- ...dvanced-entity-analytics-overview.asciidoc | 2 ++ .../ers-req.asciidoc | 0 .../ml-req.asciidoc | 0 docs/cases/cases-index.asciidoc | 2 ++ .../cases-req.asciidoc | 0 docs/detections/detections-index.asciidoc | 2 ++ .../detections-req.asciidoc | 0 docs/getting-started/explore-intro.asciidoc | 1 + docs/getting-started/index.asciidoc | 19 +++++++++++++------ docs/index.asciidoc | 2 -- 10 files changed, 20 insertions(+), 8 deletions(-) rename docs/{getting-started => advanced-entity-analytics}/ers-req.asciidoc (100%) rename docs/{getting-started => advanced-entity-analytics}/ml-req.asciidoc (100%) rename docs/{getting-started => cases}/cases-req.asciidoc (100%) rename docs/{getting-started => detections}/detections-req.asciidoc (100%) diff --git a/docs/advanced-entity-analytics/advanced-entity-analytics-overview.asciidoc b/docs/advanced-entity-analytics/advanced-entity-analytics-overview.asciidoc index 802809a1b5..75a9b450e4 100644 --- a/docs/advanced-entity-analytics/advanced-entity-analytics-overview.asciidoc +++ b/docs/advanced-entity-analytics/advanced-entity-analytics-overview.asciidoc @@ -8,11 +8,13 @@ Advanced Entity Analytics provides two key capabilities: * <> * <> +include::ers-req.asciidoc[leveloffset=+1] include::entity-risk-scoring.asciidoc[leveloffset=+1] include::asset-criticality.asciidoc[leveloffset=+2] include::turn-on-risk-engine.asciidoc[leveloffset=+2] include::analyze-risk-score-data.asciidoc[leveloffset=+2] include::advanced-behavioral-detections.asciidoc[leveloffset=+1] +include::ml-req.asciidoc[leveloffset=+2] include::machine-learning.asciidoc[leveloffset=+2] include::tune-anomaly-results.asciidoc[leveloffset=+2] include::behavioral-detection-use-cases.asciidoc[leveloffset=+2] diff --git a/docs/getting-started/ers-req.asciidoc b/docs/advanced-entity-analytics/ers-req.asciidoc similarity index 100% rename from docs/getting-started/ers-req.asciidoc rename to docs/advanced-entity-analytics/ers-req.asciidoc diff --git a/docs/getting-started/ml-req.asciidoc b/docs/advanced-entity-analytics/ml-req.asciidoc similarity index 100% rename from docs/getting-started/ml-req.asciidoc rename to docs/advanced-entity-analytics/ml-req.asciidoc diff --git a/docs/cases/cases-index.asciidoc b/docs/cases/cases-index.asciidoc index 48ee2bf5d6..9161fabbb8 100644 --- a/docs/cases/cases-index.asciidoc +++ b/docs/cases/cases-index.asciidoc @@ -1,5 +1,7 @@ include::cases-overview.asciidoc[leveloffset=+1] +include::cases-req.asciidoc[leveloffset=+1] + include::cases-manage.asciidoc[leveloffset=+2] include::cases-manage-settings.asciidoc[leveloffset=+1] diff --git a/docs/getting-started/cases-req.asciidoc b/docs/cases/cases-req.asciidoc similarity index 100% rename from docs/getting-started/cases-req.asciidoc rename to docs/cases/cases-req.asciidoc diff --git a/docs/detections/detections-index.asciidoc b/docs/detections/detections-index.asciidoc index da13686789..25aa7c63b2 100644 --- a/docs/detections/detections-index.asciidoc +++ b/docs/detections/detections-index.asciidoc @@ -2,6 +2,8 @@ include::detection-engine-intro.asciidoc[] include::about-rules.asciidoc[] +include::detections-req.asciidoc[leveloffset=+1] + include::rules-ui-create.asciidoc[] include::rules-cross-cluster-search.asciidoc[leveloffset=+1] diff --git a/docs/getting-started/detections-req.asciidoc b/docs/detections/detections-req.asciidoc similarity index 100% rename from docs/getting-started/detections-req.asciidoc rename to docs/detections/detections-req.asciidoc diff --git a/docs/getting-started/explore-intro.asciidoc b/docs/getting-started/explore-intro.asciidoc index c55a0a74b6..c65bcd8aba 100644 --- a/docs/getting-started/explore-intro.asciidoc +++ b/docs/getting-started/explore-intro.asciidoc @@ -6,4 +6,5 @@ The following section includes an overview of the *Hosts*, *Network*, and *Users include::{security-docs-root}/docs/management/hosts/hosts-overview.asciidoc[leveloffset=+1] include::network-page-overview.asciidoc[leveloffset=+1] +include::net-map-req.asciidoc[leveloffset=+2] include::users-page.asciidoc[leveloffset=+1] diff --git a/docs/getting-started/index.asciidoc b/docs/getting-started/index.asciidoc index 0d02573d95..2933195802 100644 --- a/docs/getting-started/index.asciidoc +++ b/docs/getting-started/index.asciidoc @@ -7,31 +7,38 @@ Looking to get started with {elastic-sec}? This section describes the {elastic-s TIP: View the https://www.elastic.co/training/elastic-security-quick-start[{elastic-sec} Quick Start video] to learn how to configure your endpoints with {elastic-sec} so you can stream, detect, and visualize threats in real time on {ecloud}. include::sec-app-requirements.asciidoc[leveloffset=+1] -include::detections-req.asciidoc[leveloffset=+2] -include::cases-req.asciidoc[leveloffset=+2] -include::ers-req.asciidoc[leveloffset=+2] -include::ml-req.asciidoc[leveloffset=+2] include::defend-feature-privs.asciidoc[leveloffset=+2] -include::net-map-req.asciidoc[leveloffset=+2] + +include::getting-started/security-ui.asciidoc[leveloffest=+1] + include::endgame-sensor-reqs.asciidoc[leveloffset=+1] include::endgame-sensor-FDA.asciidoc[leveloffset=+2] include::endgame-sensor-FDA-ven.asciidoc[leveloffset=+2] + include::security-spaces.asciidoc[leveloffset=+1] + include::data-views-in-sec.asciidoc[leveloffset=+1] + include::ingest-data.asciidoc[leveloffset=+1] +include::threat-intel-integrations.asciidoc[leveloffset=+2] + include::install-endpoint.asciidoc[leveloffset=+1] include::agent-tamper-protection.asciidoc[leveloffset=+2] include::uninstall-agent.asciidoc[leveloffset=+2] include::uninstall-endpoint.asciidoc[leveloffset=+2] + include::elastic-endpoint-reqs.asciidoc[leveloffset=+1] include::install-elastic-endpoint.asciidoc[leveloffset=+2] include::install-elastic-endpoint-ven.asciidoc[leveloffset=+2] + include::offline-endpoint.asciidoc[leveloffset=+1] + include::configure-integration-policy.asciidoc[leveloffset=+1] include::artifact-control.asciidoc[leveloffset=+2] include::endpoint-diagnostic-data.asciidoc[leveloffset=+2] include::self-healing-rollback.asciidoc[leveloffset=+2] include::linux-file-monitoring.asciidoc[leveloffset=+2] include::create-defend-policy-api.asciidoc[leveloffset=+2] -include::threat-intel-integrations.asciidoc[leveloffset=+1] + + include::advanced-setting.asciidoc[leveloffset=+1] diff --git a/docs/index.asciidoc b/docs/index.asciidoc index 0194e513d9..5a4329a89d 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -16,8 +16,6 @@ include::post-upgrade/post-upgrade-intro.asciidoc[] include::getting-started/index.asciidoc[] -include::getting-started/security-ui.asciidoc[] - include::AI-for-security/ai-for-security.asciidoc[] include::dashboards/dashboards-overview.asciidoc[] From a3d06179d1f907af0b2e538b78f468a8bcc50732 Mon Sep 17 00:00:00 2001 From: Benjamin Ironside Goldstein Date: Tue, 23 Jul 2024 13:49:52 -0700 Subject: [PATCH 2/5] troubleshoot build error --- docs/getting-started/index.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/index.asciidoc b/docs/getting-started/index.asciidoc index 2933195802..74b81f879c 100644 --- a/docs/getting-started/index.asciidoc +++ b/docs/getting-started/index.asciidoc @@ -9,7 +9,7 @@ TIP: View the https://www.elastic.co/training/elastic-security-quick-start[{elas include::sec-app-requirements.asciidoc[leveloffset=+1] include::defend-feature-privs.asciidoc[leveloffset=+2] -include::getting-started/security-ui.asciidoc[leveloffest=+1] +include::security-ui.asciidoc[leveloffset=+1] include::endgame-sensor-reqs.asciidoc[leveloffset=+1] include::endgame-sensor-FDA.asciidoc[leveloffset=+2] From bbab8a0744ac091b1f3517845132c0931233f8f1 Mon Sep 17 00:00:00 2001 From: Benjamin Ironside Goldstein <91905639+benironside@users.noreply.github.com> Date: Wed, 24 Jul 2024 09:58:16 -0700 Subject: [PATCH 3/5] Update docs/cases/cases-index.asciidoc Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> --- docs/cases/cases-index.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/cases/cases-index.asciidoc b/docs/cases/cases-index.asciidoc index 9161fabbb8..d3ce35efcd 100644 --- a/docs/cases/cases-index.asciidoc +++ b/docs/cases/cases-index.asciidoc @@ -1,6 +1,6 @@ include::cases-overview.asciidoc[leveloffset=+1] -include::cases-req.asciidoc[leveloffset=+1] +include::cases-req.asciidoc[leveloffset=+2] include::cases-manage.asciidoc[leveloffset=+2] From ae598af61ad84bcc9a5479ad2d5da4b4c19b5708 Mon Sep 17 00:00:00 2001 From: Benjamin Ironside Goldstein <91905639+benironside@users.noreply.github.com> Date: Thu, 25 Jul 2024 09:38:58 -0700 Subject: [PATCH 4/5] Update docs/advanced-entity-analytics/advanced-entity-analytics-overview.asciidoc Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com> --- .../advanced-entity-analytics-overview.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/advanced-entity-analytics/advanced-entity-analytics-overview.asciidoc b/docs/advanced-entity-analytics/advanced-entity-analytics-overview.asciidoc index 75a9b450e4..9cbc09753b 100644 --- a/docs/advanced-entity-analytics/advanced-entity-analytics-overview.asciidoc +++ b/docs/advanced-entity-analytics/advanced-entity-analytics-overview.asciidoc @@ -8,8 +8,8 @@ Advanced Entity Analytics provides two key capabilities: * <> * <> -include::ers-req.asciidoc[leveloffset=+1] include::entity-risk-scoring.asciidoc[leveloffset=+1] +include::ers-req.asciidoc[leveloffset=+2] include::asset-criticality.asciidoc[leveloffset=+2] include::turn-on-risk-engine.asciidoc[leveloffset=+2] include::analyze-risk-score-data.asciidoc[leveloffset=+2] From 9695912bb1df99578c75a2bd82108265f54227cd Mon Sep 17 00:00:00 2001 From: Benjamin Ironside Goldstein Date: Tue, 30 Jul 2024 12:45:31 -0700 Subject: [PATCH 5/5] Incorporates feedback --- docs/detections/detections-index.asciidoc | 3 ++- docs/getting-started/index.asciidoc | 6 +++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/detections/detections-index.asciidoc b/docs/detections/detections-index.asciidoc index 25aa7c63b2..c2953634c6 100644 --- a/docs/detections/detections-index.asciidoc +++ b/docs/detections/detections-index.asciidoc @@ -1,8 +1,9 @@ include::detection-engine-intro.asciidoc[] +include::detections-req.asciidoc[leveloffset=+1] + include::about-rules.asciidoc[] -include::detections-req.asciidoc[leveloffset=+1] include::rules-ui-create.asciidoc[] diff --git a/docs/getting-started/index.asciidoc b/docs/getting-started/index.asciidoc index 74b81f879c..997f0bed55 100644 --- a/docs/getting-started/index.asciidoc +++ b/docs/getting-started/index.asciidoc @@ -15,13 +15,13 @@ include::endgame-sensor-reqs.asciidoc[leveloffset=+1] include::endgame-sensor-FDA.asciidoc[leveloffset=+2] include::endgame-sensor-FDA-ven.asciidoc[leveloffset=+2] +include::ingest-data.asciidoc[leveloffset=+1] +include::threat-intel-integrations.asciidoc[leveloffset=+2] + include::security-spaces.asciidoc[leveloffset=+1] include::data-views-in-sec.asciidoc[leveloffset=+1] -include::ingest-data.asciidoc[leveloffset=+1] -include::threat-intel-integrations.asciidoc[leveloffset=+2] - include::install-endpoint.asciidoc[leveloffset=+1] include::agent-tamper-protection.asciidoc[leveloffset=+2] include::uninstall-agent.asciidoc[leveloffset=+2]