fix(readmes): fixes spacing in the readmes for rendering

Example_readme.md

@@ -28,12 +28,12 @@ List what resources your template provides in this section. That will allow user
 
 **Example:**
 
-    - 1 Bucket: `Telegraf`, 7d retention
-    - 3 Labels: `InfluxDB1.x`,`Solution`,`Telegraf`
-    - 1 Telegraf Configuration
-    - 3 Checks: `Disk Usage Check`, `Host Deadman`, and `Memory Usage Check`
-    - 2 Dashboards: `InfluxDB 1.x` and `Telegraf`
-    - 3 Variables: `bucket`, `influxdb_host`, and `telegraf_host`
+  - 1 Bucket: `Telegraf`, 7d retention
+  - 3 Labels: `InfluxDB1.x`,`Solution`,`Telegraf`
+  - 1 Telegraf Configuration
+  - 3 Checks: `Disk Usage Check`, `Host Deadman`, and `Memory Usage Check`
+  - 2 Dashboards: `InfluxDB 1.x` and `Telegraf`
+  - 3 Variables: `bucket`, `influxdb_host`, and `telegraf_host`
 
 ## Setup Instructions
 
@@ -43,21 +43,21 @@ Describe any steps needed to finish setting up and running your template, includ
 
 **Example:**
 
-    Telegraf Configuration requires the following environment variables
-    - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started.
-    - `INFLUX_ORG` - The name of your Organization
+Telegraf Configuration requires the following environment variables
+  - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started.
+  - `INFLUX_ORG` - The name of your Organization
 
-    You **MUST** set these environment variables before running Telegraf using something similar to the following commands
-    - This can be found on the `Load Data` > `Tokens` page in your browser: `export INFLUX_TOKEN=TOKEN`
-    - Your Organization name can be found on the Settings page in your browser: `export INFLUX_ORG=my_org`
+You **MUST** set these environment variables before running Telegraf using something similar to the following commands
+  - This can be found on the `Load Data` > `Tokens` page in your browser: `export INFLUX_TOKEN=TOKEN`
+  - Your Organization name can be found on the Settings page in your browser: `export INFLUX_ORG=my_org`
 
 ## Customizations
 
 Show off the flexibility of your template by letting users know different ways they can use it other than the defaults you provide.
 
 **Example:**
 
-    You can easily update the Telegraf configurations to point to a specific InfluxDB 1.x location by setting the options in the [InfluxDB Input](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/influxdb) or the [InfluxDB 2.0 Output](https://github.com/influxdata/telegraf/tree/master/plugins/outputs/influxdb_v2). 
+You can easily update the Telegraf configurations to point to a specific InfluxDB 1.x location by setting the options in the [InfluxDB Input](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/influxdb) or the [InfluxDB 2.0 Output](https://github.com/influxdata/telegraf/tree/master/plugins/outputs/influxdb_v2). 
 
 ## Contact
 

InfluxDBv2_Covid19_SouthAmerica/readme.md

@@ -21,20 +21,20 @@ influx apply -u https://raw.githubusercontent.com/influxdata/community-templates
 
 ## Included Resources
 
-    - 1 Bucket: 'covid'
-    - 5 .sh files that get the information from the API and convert in JSON.
-    - 1 Dashboards: covid.yml - COVID19 América del Sur y Resto del mundo
-    - 1 Telegraf: 'Configuration: Exec Inputs'
-    - 1 Label: 'covid'
+  - 1 Bucket: 'covid'
+  - 5 .sh files that get the information from the API and convert in JSON.
+  - 1 Dashboards: covid.yml - COVID19 América del Sur y Resto del mundo
+  - 1 Telegraf: 'Configuration: Exec Inputs'
+  - 1 Label: 'covid'
 
 ## Setup Instructions
 
 General instructions on using InfluxDB Templates can be found in the [use a template](../docs/use_a_template.md) document.
 
-    Telegraf Configuration requires the following environment variables
-    - `INFLUX_HOST` - The host running InfluxDB
-    - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started.
-    - `INFLUX_ORG` - The name of your Organization.
+Telegraf Configuration requires the following environment variables
+  - `INFLUX_HOST` - The host running InfluxDB
+  - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started.
+  - `INFLUX_ORG` - The name of your Organization.
 
 As the bucket was provided in this template, you need to set the following environment data ```export INFLUX_BUCKET=covid```. Also may requiere adjust the information about the location of the executables files and set the agent interval to at least 1h, this for not hit to the api too much and cause service disruption.
 

apache_jmeter/readme.md

@@ -39,8 +39,8 @@ influx apply -u https://raw.githubusercontent.com/influxdata/community-templates
 
 The template consists of the following:
 
-    - 1 Dashboard: `JMeter`
-    - 1 Variable: `bucket`
+  - 1 Dashboard: `JMeter`
+  - 1 Variable: `bucket`
 
 The sample **Test Plan** boilerplate project in the `samples` directory.
 
@@ -52,7 +52,7 @@ General instructions on using InfluxDB Templates can be found in the [use a temp
 **Import the template**
 
 ```
- influx apply --file ./apache_jmeter.yml
+influx apply --file ./apache_jmeter.yml
 ```
 
 **Start with a sample test project:**

apex_legends/readme.md

@@ -25,9 +25,9 @@ influx apply -u https://raw.githubusercontent.com/influxdata/community-templates
 
 ## Included Resources
 
-    - 1 Bucket: apexlegends
-    - 2 Dashboards: Apex Legends for InfluxDB 2 and for Grafana
-    - 1 Label: Game Data
+  - 1 Bucket: apexlegends
+  - 2 Dashboards: Apex Legends for InfluxDB 2 and for Grafana
+  - 1 Label: Game Data
 
 ## Setup Instructions
 
@@ -53,13 +53,14 @@ Due to limitations on the API and the way Telegraf processes the JSON data it's
 
 This will run curl every 5 minutes to pull the stats from the API endpoint and write them to `/etc/telegraf/apex_legends.json` - This can be anywhere your Telegraf instance can read from.
 
-    Telegraf Configuration requires the following environment variables
-    - `INFLUX_HOST` - The URL for your InfluxDB instance.
-    - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started.
-    - `INFLUX_ORG` - The name of your Organization
-    You **MUST** set these environment variables before running Telegraf using something similar to the following commands
-    - This can be found on the `Load Data` > `Tokens` page in your browser: `export INFLUX_TOKEN=TOKEN`
-    - Your Organization name can be found on the Settings page in your browser: `export INFLUX_ORG=my_org`
+Telegraf Configuration requires the following environment variables
+  - `INFLUX_HOST` - The URL for your InfluxDB instance.
+  - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started.
+  - `INFLUX_ORG` - The name of your Organization
+
+You **MUST** set these environment variables before running Telegraf using something similar to the following commands
+  - This can be found on the `Load Data` > `Tokens` page in your browser: `export INFLUX_TOKEN=TOKEN`
+  - Your Organization name can be found on the Settings page in your browser: `export INFLUX_ORG=my_org`
 
 ## Contact
 

csgo/readme.md

@@ -21,21 +21,21 @@ influx apply -u https://raw.githubusercontent.com/influxdata/community-templates
 
 ## Included Resources
 
-    - 1 Telegraf Configuration: 'csgo-telegraf'
-    - 1 Dashboards
-    - 1 Label: 'csgo'
-    - 1 Bucket: 'csgo'
-    - 1 Executable: 'csgo.sh'
+  - 1 Telegraf Configuration: 'csgo-telegraf'
+  - 1 Dashboards
+  - 1 Label: 'csgo'
+  - 1 Bucket: 'csgo'
+  - 1 Executable: 'csgo.sh'
 
 ## Setup Instructions
 
 General instructions on using InfluxDB Templates can be found in the [use a template](../docs/use_a_template.md) document.
 
-    Telegraf Configuration requires the following environment variables
-    - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started.
-    - `INFLUX_ORG` - The name of your Organization.
-    - `INFLUX_HOST` - The address of you InfluxDB
-    - `INFLUX_BUCKET` - The name of the Bucket. If you going to use the bucket included, you need to export the variable. Ex: ```INFLUX_BUCKET=mssql```
+Telegraf Configuration requires the following environment variables
+  - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started.
+  - `INFLUX_ORG` - The name of your Organization.
+  - `INFLUX_HOST` - The address of you InfluxDB
+  - `INFLUX_BUCKET` - The name of the Bucket. If you going to use the bucket included, you need to export the variable. Ex: ```INFLUX_BUCKET=mssql```
 
 In order to use this dashboard you need to get an API key and your Steam User ID:
 

docs/best_practices.md

@@ -18,9 +18,9 @@ Rather than duplicating graphs to show filtered views of the same data, use [Var
 
 When using Buckets in your Template, you can:
 
- - Provide a default Bucket with your Template
- - Reuse an existing Bucket by name
- - Let the user choose their Bucket
+  - Provide a default Bucket with your Template
+  - Reuse an existing Bucket by name
+  - Let the user choose their Bucket
 
 #### Provide a default Bucket with your Template
 You can include a uniquely-named [Bucket](https://v2.docs.influxdata.com/v2.0/reference/key-concepts/data-elements/#bucket) with your Template and use it as the default in Dashboards and Telegraf configurations.
@@ -135,16 +135,16 @@ To add a custom Telegraf configuration file to your template:
  1. Export your template using the command in the [submitting a template](submit_a_template.md) doc.
 
  2. Add the following to the end of the file, being sure to give a name for your Telegraf configuration:
-    ```
-    ---
-    apiVersion: influxdata.com/v2alpha1
-    kind: Telegraf
-    metadata:
-        name: unique-name-for-your-config
-    spec:
-        name: The Name Of Your Configuration
-        config: |
-    ```
+```
+---
+apiVersion: influxdata.com/v2alpha1
+kind: Telegraf
+metadata:
+    name: unique-name-for-your-config
+spec:
+    name: The Name Of Your Configuration
+    config: |
+```
         
  3. Copy and paste the contents of your Telegraf configuration file below what you just added, indenting it all until it is 4 spaces further indented than the `config:` line.
 
@@ -156,8 +156,7 @@ After you export your finished Template, test it to make sure that it applies cl
 To create a clean, ephemeral InfluxDB testing environment, run InfluxDB inside of a Docker container:
 
 ```
- docker run -p 8086:8086 -p 9999:9999 quay.io/influxdb/influxdb:2.0.0-beta
-
+docker run -p 8086:8086 -p 9999:9999 quay.io/influxdb/influxdb:2.0.0-beta
 ```
 
 After you create a new `Organization` and `Token` in your Docker instance (available at http://localhost:9999), follow the [instructions for using a Template](./use_a_template.md) to apply your Template.

endpoint-security-state/readme.md

@@ -28,10 +28,10 @@ influx apply --template-url https://raw.githubusercontent.com/influxdata/communi
 - 4 Labels: `outputs.influxdb_v2`, `Telegraf`, `Solution`, `security`
 - 1 Telegraf Configuration 
 - 4 Checks: 
-    - Endpoint availablility
-    - x509 Certificate status
-    - Authentication is enabled
-    - Authentication is working
+  - Endpoint availablility
+  - x509 Certificate status
+  - Authentication is enabled
+  - Authentication is working
 - 1 Dashboard: `Endpoint Security State`
 - 1 Variable: `bucket`
 

fortnite/readme.md

@@ -41,48 +41,48 @@ Note: If `fortnite` is not used for the `fn_bucket` name, the bucket name will n
 
 ## Included Resources
 - 1 Bucket: `fortnite`
-    - 30d retention
-    - `fn_bucket` - user-definable resource name
+  - 30d retention
+  - `fn_bucket` - user-definable resource name
 - 1 Label: `fortnite`
 - 1 Telegraf Configuration
-    - `exec` input plugin
-    - `influxdb_v2` output plugin
+  - `exec` input plugin
+  - `influxdb_v2` output plugin
 - 1 Task: `wins`
-    - uses Slack webhook
+  - uses Slack webhook
 - 3 Dashboards:
-    - `Fortnite - All Players`
-    - `Fortnite - Individual Stats`
-    - `Fortnite - Player Comparison`
+  - `Fortnite - All Players`
+  - `Fortnite - Individual Stats`
+  - `Fortnite - Player Comparison`
 - 4 Query Variables:
-    - `bucket`
-    - `player`
-    - `player2`
-    - `season`
+  - `bucket`
+  - `player`
+  - `player2`
+  - `season`
 - 1 Python script: `get_fn_stats.py`
-    - used by Telegraf exec plugin to access Fortnite API endpoint
+  - used by Telegraf exec plugin to access Fortnite API endpoint
 - 1 CSV file: `players.csv`
-    - seeded with professional Fortnite player ids
-    - used by Python script
+  - seeded with professional Fortnite player ids
+  - used by Python script
 
 ## Setup Instructions
 
 1. Register for an account at [fortniteapi.io](https://fortniteapi.io/)
 2. Retrieve your Fortnite API token at [dashboard.fortniteapi.io](https://dashboard.fortniteapi.io)
 3. Look up Fortnite account ids with the following curl request:
-    ```
-    curl --request GET 'https://fortniteapi.io/lookup?username=<USERNAME>' \
-         --header 'Authorization: <FORTNITE_API_TOKEN>'
-    ```
+```
+curl --request GET 'https://fortniteapi.io/lookup?username=<USERNAME>' \
+     --header 'Authorization: <FORTNITE_API_TOKEN>'
+```
 4. Check that the account returns metrics:
-    ```
-    curl --request GET 'https://fortniteapi.io/stats?account=<PLAYER_ID>&season=<SEASON>' \
-         --header 'Authorization: <FORTNITE_API_TOKEN>'
-    ```
-    - Note: If the response contains `"global_stats":null` it's likely that that the **Show on Career Leaderboard** setting is set to **OFF** in the **Account and Privacy** section of the player's profile.
+```
+curl --request GET 'https://fortniteapi.io/stats?account=<PLAYER_ID>&season=<SEASON>' \
+     --header 'Authorization: <FORTNITE_API_TOKEN>'
+```
+  - Note: If the response contains `"global_stats":null` it's likely that that the **Show on Career Leaderboard** setting is set to **OFF** in the **Account and Privacy** section of the player's profile.
 
 5. Add accounts to track in `players.csv`. For example:
-    - `4735ce9132924caf8a5b17789b40f79c,yes,Ninja`
-    - The second column indicates professional status: `yes`|`no`
+  - `4735ce9132924caf8a5b17789b40f79c,yes,Ninja`
+  - The second column indicates professional status: `yes`|`no`
 
 ### Telegraf
 The Telegraf configuration requires the following environmental variables:
@@ -96,15 +96,15 @@ Information on using enviromental variables can be found in the [Telegraf Config
 
 The Telegraf `exec` input plugin requires the following files:
 - `get_fn_stats.py` - Python script used to ingest metrics via the unofficial [Fortnite API](https://fortniteapi.io/)
-    - `requests` module required
-    - The current season is hardcoded: `season = 14`
-        - Update this when a new season starts.
+  - `requests` module required
+  - The current season is hardcoded: `season = 14`
+    - Update this when a new season starts.
 
 - `players.csv` - CSV file containing a list of players to track using the following fields:
-    - `acct_id` - Fortnite Account ID
-    - `pro` - **yes** for professional, **no** for friends and family
-    - `player_name` - not used by Telegraf
-    - Note: This file is populated with several professional players. Add friends, family and others that will be tracked separately from the pro players.
+  - `acct_id` - Fortnite Account ID
+  - `pro` - **yes** for professional, **no** for friends and family
+  - `player_name` - not used by Telegraf
+  - Note: This file is populated with several professional players. Add friends, family and others that will be tracked separately from the pro players.
 
 ### Dashboards
 The `Fortnite - All Players` dashboard displays a url drilldown to the `Fortnite - Individual Stats` dashboard. This url must be changed in the `Friends & Family` and `Pros` cells:
@@ -117,7 +117,7 @@ To get the full link, open the `Fortnite - Individual Stats` dashboard and copy
 The Influx task requires the following [influx secret](https://v2.docs.influxdata.com/v2.0/reference/cli/influx/secret/):
 
 - `SLACK_WEBHOOK` - The Slack webhook is used to send a message when a player wins a match.
-    - https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX
+  - https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX
 ```
 influx secret update -k SLACK_WEBHOOK
 ```

github/readme.md

@@ -21,20 +21,20 @@ influx apply -u https://raw.githubusercontent.com/influxdata/community-templates
 
 ## Included Resources
 
-    - 1 Telegraf: `Configuration: Github Inputs`
-    - 1 Dashboards: `Github - InfluxData [InfluxDB & Telegraf repos]`
-    - 1 Bucket: `github`
-    - 1 Label: `github`
+  - 1 Telegraf: `Configuration: Github Inputs`
+  - 1 Dashboards: `Github - InfluxData [InfluxDB & Telegraf repos]`
+  - 1 Bucket: `github`
+  - 1 Label: `github`
 
 ## Setup Instructions
 
 General instructions on using InfluxDB Templates can be found in the [use a template](../docs/use_a_template.md) document.
 
-    Telegraf Configuration requires the following environment variables
-    - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started.
-    - `INFLUX_ORG` - The name of your Organization.
-    - `INFLUX_HOST` - The URL of your InfluxDB host (this can be your localhost, a remote instance, or InfluxDB Cloud).
-    - `GITHUB_ACCESS_TOKEN` - Your personal Github token for making API calls
+Telegraf Configuration requires the following environment variables
+  - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started.
+  - `INFLUX_ORG` - The name of your Organization.
+  - `INFLUX_HOST` - The URL of your InfluxDB host (this can be your localhost, a remote instance, or InfluxDB Cloud).
+  - `GITHUB_ACCESS_TOKEN` - Your personal Github token for making API calls
 
 > You can generate a Token Access Key from Github on this page: https://github.com/settings/tokens. 
 

haproxy/readme.md

@@ -21,19 +21,19 @@ influx apply -u https://raw.githubusercontent.com/influxdata/community-templates
 
 ## Included Resources
 
-    - 1 Telegraf: `haproxy-config`
-    - 1 Dashboards: `haproxy`
-    - 1 Bucket: `haproxy`
-    - 1 Label: `haproxy`
+  - 1 Telegraf: `haproxy-config`
+  - 1 Dashboards: `haproxy`
+  - 1 Bucket: `haproxy`
+  - 1 Label: `haproxy`
 
 ## Setup Instructions
 
 General instructions on using InfluxDB Templates can be found in the [use a template](../docs/use_a_template.md) document.
 
-    Telegraf Configuration requires the following environment variables
-    - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started.
-    - `INFLUX_ORG` - The name of your Organization.
-    - `INFLUX_HOST` - The host where run InfluxDB
+Telegraf Configuration requires the following environment variables
+  - `INFLUX_TOKEN` - The token with the permissions to read Telegraf configs and write data to the `telegraf` bucket. You can just use your operator token to get started.
+  - `INFLUX_ORG` - The name of your Organization.
+  - `INFLUX_HOST` - The host where run InfluxDB
 
 In order to use this template, you need to specify the HAProxy instance, if you have one to monitor, you can pass as variable the name and port of the host. Ex ```$ export haproxy_stats=http://localhost:10000/stats```
 If you have more instances of HAProxy I recommend you to edit the haproxy.yml to add others hosts.