Merge pull request #5 from ZachChristensen28/docs/devel

latest documentation
splunk · Aug 26, 2022 · 3e1a565 · 3e1a565
2 parents e96e892 + 620e7b4
commit 3e1a565
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 3 deletions.
diff --git a/.github/workflows/appinspect.yml b/.github/workflows/appinspect.yml
@@ -4,7 +4,8 @@ on:
     branches:
       - main
       - master
-      - "!docs/**"
+    paths:
+      - "src/**"
     types: [opened, ready_for_review]
 jobs:
   validate:

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -4,6 +4,9 @@ on:
     branches:
       - master
       - main
+    paths:
+      - "docs/**"
+      - "mkdocs.yml"
 jobs:
   deploy:
     runs-on: ubuntu-latest

diff --git a/docs/index.md b/docs/index.md
@@ -35,4 +35,4 @@ Splunk Enterprise Security Version <small>(Required)</small> | [7.x, 6.x](https:
 Crowdstrike Devices Add-on <small>(Required)</small> | [3.x](https://splunkbase.splunk.com/app/5570)
 Add-on has a web UI | No, this add-on does not contain views.
 
-[Quick Start](quickstart/install){ .md-button .md-button--primary }
+[Quick Start](quickstart/install-dependencies){ .md-button .md-button--primary }
diff --git a/docs/quickstart/install.md b/docs/quickstart/install.md
@@ -1,7 +1,7 @@
 # Install
 
 !!! important
-    This supporting add-on must be installed alongside Splunk Enterprise Security.
+    This supporting add-on must be installed alongside Splunk Enterprise Security. Ensure the [prequisites](../prerequisites) have been completed before proceeding.
 
 For detailed information on where to install Splunk Apps/add-ons, including best practices, can be found at [Splunk Docs: About Installing Splunk add-ons](https://docs.splunk.com/Documentation/AddOns/released/Overview/Wheretoinstall)
 

diff --git a/docs/quickstart/prerequisites.md b/docs/quickstart/prerequisites.md
@@ -0,0 +1,9 @@
+# Prerequisites
+
+!!! important
+    Complete the prerequisites before installing this add-on.
+
+Required App | Version | Description
+------------ | ------- | -----------
+[Splunk Enterprise Security](https://splunkbase.splunk.com/app/263) | 7.x, 6.x | This add-on supports Splunk ES and is not designed to work without it.
+[Crowdstrike Devices technical add-on](https://splunkbase.splunk.com/app/5570) | 3.x | Crowdstrike device data must be brought in prior to installing this add-on. See [Crowdstrike's documentation](https://www.crowdstrike.com/resources/guides/crowdstrike-falcon-devices-add-on-for-splunk-guide-3-1/) for more information.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -70,6 +70,7 @@ extra:
 nav:
   - Home: index.md
   - Quick Start:
+      - Prerequisites: quickstart/prerequisites.md
       - Install: quickstart/install.md
       - Quickstart: quickstart/quickstart.md
   - Configure: