Skip to content
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

latest documentation #5

Merged
merged 3 commits into from
Aug 26, 2022
Merged

latest documentation #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
711f7d5
adding dependency documentation
ZachChristensen28 Aug 26, 2022
ad6e1d1
excluding docs from wfa
ZachChristensen28 Aug 26, 2022
620e7b4
adding docs to wfa
ZachChristensen28 Aug 26, 2022
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
3 changes: 2 additions & 1 deletion .github/workflows/appinspect.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ on:
branches:
- main
- master
- "!docs/**"
paths:
- "src/**"
types: [opened, ready_for_review]
jobs:
validate:
Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ on:
branches:
- master
- main
paths:
- "docs/**"
- "mkdocs.yml"
jobs:
deploy:
runs-on: ubuntu-latest
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 }
2 changes: 1 addition & 1 deletion docs/quickstart/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)

Expand Down
9 changes: 9 additions & 0 deletions docs/quickstart/prerequisites.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
1 change: 1 addition & 0 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ extra:
nav:
- Home: index.md
- Quick Start:
- Prerequisites: quickstart/prerequisites.md
- Install: quickstart/install.md
- Quickstart: quickstart/quickstart.md
- Configure:
Expand Down