Skip to content

Commit f7a8d8c

Browse files
committed
docs:highlighted usage of npm in developer readmes
1 parent 572ae8d commit f7a8d8c

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

packages/splunk_plotly_collection_viz/appserver/static/visualizations/boxplot/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
This is the basic template for a splunk visualization app. This teamplate is meant to be edited to build custom visualizations. It contains:
44

5-
- The relevant directory structure for a visuzliation app
5+
- The relevant directory structure for a visualization app
66
- A standin visualization package directory with a standin visualiztion and a basic webpack configuration
77
- Relevant .conf files for the visualization
88

99
## Building the visualization
1010

11-
NOTE: You must have npm installed in oder to build. If you do not have npm installed, install it and come back.
12-
11+
:point_right: You **must have npm installed** in oder to build. If you do not have npm installed, install it and come back. :point_left:
12+
1313
The visualization contained in this app must be built using web pack in order to run it on Splunk. There is a basic webpack configuration built in to the app. To build from the command line, first, cd to the *visualization/standin* directory. On the first run you will have to install the dependeincies with npm:
1414

1515
```
@@ -21,7 +21,7 @@ Once you done that, you can build the viz with the provided build task:
2121
$ npm run build
2222
```
2323

24-
This will create a *visualization.js* file in the visualization directory.
24+
This will create a *visualization.js* file in the visualization directory.
2525

2626
## Adding Your Own Code
2727

packages/splunk_plotly_collection_viz/appserver/static/visualizations/multiple-axes/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
This is the basic template for a splunk visualization app. This teamplate is meant to be edited to build custom visualizations. It contains:
44

5-
- The relevant directory structure for a visuzliation app
5+
- The relevant directory structure for a visualization app
66
- A standin visualization package directory with a standin visualiztion and a basic webpack configuration
77
- Relevant .conf files for the visualization
88

99
## Building the visualization
1010

11-
NOTE: You must have npm installed in oder to build. If you do not have npm installed, install it and come back.
12-
11+
:point_right: You **must have npm installed** in oder to build. If you do not have npm installed, install it and come back. :point_left:
12+
1313
The visualization contained in this app must be built using web pack in order to run it on Splunk. There is a basic webpack configuration built in to the app. To build from the command line, first, cd to the *visualization/standin* directory. On the first run you will have to install the dependeincies with npm:
1414

1515
```
@@ -21,7 +21,7 @@ Once you done that, you can build the viz with the provided build task:
2121
$ npm run build
2222
```
2323

24-
This will create a *visualization.js* file in the visualization directory.
24+
This will create a *visualization.js* file in the visualization directory.
2525

2626
## Adding Your Own Code
2727

packages/splunk_plotly_collection_viz/appserver/static/visualizations/ohlc/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
This is the basic template for a splunk visualization app. This teamplate is meant to be edited to build custom visualizations. It contains:
44

5-
- The relevant directory structure for a visuzliation app
5+
- The relevant directory structure for a visualization app
66
- A standin visualization package directory with a standin visualiztion and a basic webpack configuration
77
- Relevant .conf files for the visualization
88

99
## Building the visualization
1010

11-
NOTE: You must have npm installed in oder to build. If you do not have npm installed, install it and come back.
12-
11+
:point_right: You **must have npm installed** in oder to build. If you do not have npm installed, install it and come back. :point_left:
12+
1313
The visualization contained in this app must be built using web pack in order to run it on Splunk. There is a basic webpack configuration built in to the app. To build from the command line, first, cd to the *visualization/standin* directory. On the first run you will have to install the dependeincies with npm:
1414

1515
```
@@ -21,7 +21,7 @@ Once you done that, you can build the viz with the provided build task:
2121
$ npm run build
2222
```
2323

24-
This will create a *visualization.js* file in the visualization directory.
24+
This will create a *visualization.js* file in the visualization directory.
2525

2626
## Adding Your Own Code
2727

0 commit comments

Comments
 (0)