Skip to content

Commit 51c39ba

Browse files
authored
Edited README and CONTRIBUTING (#28)
Co-authored-by: Erica Pescio <[email protected]>
1 parent 98a6f55 commit 51c39ba

File tree

2 files changed

+4
-11
lines changed

2 files changed

+4
-11
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,16 @@ Whether you're interested in bug-hunting, documentation, or creating entirely ne
77
If you're seeing some unexpected behavior with this project, please create an [issue](https://github.com/splunk/splunk-3D-graph-network-topology-viz/issues) on GitHub selecting the opportune template and providing requested information.
88

99
## Pull Requests
10-
We :heart: to see your fixes via pull requests!
10+
We :heart: to see your fixes via pull requests!
1111

1212
To create a pull request:
1313
* [Fork](https://guides.github.com/activities/forking/) the project
1414
* Create a branch for the issue
1515
* Make your changes on your branch
1616
* Thoroughly test your changes
17-
* Perform a [pull request](https://github.com/splunk/splunk-3D-graph-network-topology-viz/pulls) against the `develop` branch
17+
* Open a [pull request](https://github.com/splunk/splunk-3D-graph-network-topology-viz/pulls)
1818

1919
Remember:
20-
* **Any pull request to `Master` will not be accepted**
2120
* **Address an issue per branch**
2221

2322
## Semi-Automated Release

README.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,9 @@ More information around use cases on the following Splunk blogs:
1212
- Understanding and baselining network behaviour [[part 1](https://www.splunk.com/en_us/blog/machine-learning/understanding-and-baselining-network-behaviour-using-machine-learning-part-i.html) / [part 2](https://www.splunk.com/en_us/blog/machine-learning/understanding-and-baselining-network-behaviour-using-machine-learning-part-ii.html)]
1313

1414
## Installation
15+
Please refer to [Splunk Documentation](https://docs.splunk.com/Documentation/AddOns/released/Overview/Installingadd-ons) for guidance on installing this visualization in your environment. The app needs to be installed on the SH tier.
1516

16-
- [Download Splunk for your platform](http://www.splunk.com/download?r=productOverview).
17-
- Unpack/Install Splunk by running the downloaded files.
18-
- Follow the instruction on the screen.
19-
20-
Splunk-3d-graph-network-topology-viz can be downloaded from either **github** or [splunkbase](https://splunkbase.splunk.com/app/4611/) and installed in your Splunk platform. Access your Splunk instance via terminal and:
21-
- browse to your apps directory `$SPLUNK_HOME/etc/apps/`
22-
- download the app from github `git clone https://github.com/splunk/splunk-3d-graph-network-topology-viz.git`
23-
- Restart splunk to apply changes `$SPLUNK_HOME/bin/splunk restart`
17+
Download is available from either [GitHub](https://github.com/splunk/splunk-3D-graph-network-topology-viz/releases) or [Splunkbase](https://splunkbase.splunk.com/app/4611/).
2418

2519
## Usage
2620
`<search> | stats count by src dest [color_src] [color_dest] [edge_color] [weight_src] [weight_dest] [edge_weigth]`

0 commit comments

Comments
 (0)