Update docs to specify that only Python 3.6 or higher is supported

gatkin · Aug 11, 2019 · 4d706db · 4d706db
1 parent 77a2fec
commit 4d706db
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -11,7 +11,7 @@ New Relic Dashboard Builder is a command-line tool for configuring New Relic das
 
 ## Usage
 
-Install with pip
+Install with pip, note that New Relic Dashboard Builder only works with Python 3.6 or higher
 
 ```sh
 pip install nrdash

diff --git a/docs/guide.md b/docs/guide.md
@@ -80,7 +80,7 @@ dashboards:
         column: 1
         width: 3
         height: 2
-  
+
   sample-dashboard-2:
     title: Sample Dashboard 2
     widgets:
@@ -206,7 +206,7 @@ queries:
     condition: all-rabbit-queues-condition
     output: total-consumers-output
     display: current-value-by-name-display
-  
+
   rabbit-queue-publish-rate-query:
     title: RabbitMQ Message Publish Rate
     event: RabbitmqQueueSample
@@ -220,7 +220,7 @@ queries:
     condition: service-a-production-rabbit-queues-condition
     output: total-consumers-output
     display: current-value-by-name-display
-  
+
   service-a-rabbit-queue-publish-rate-query:
     title: RabbitMQ Message Publish Rate
     event: RabbitmqQueueSample
@@ -245,7 +245,7 @@ dashboards:
         column: 1
         width: 1
         height: 1
-    
+
   service-a-rabbit-mq-dashboard:
     title: Sample Dashboard 2
     widgets:

diff --git a/docs/index.md b/docs/index.md
@@ -22,13 +22,13 @@ The New Relic Dashboard Builder command line tool that can be installed from [Py
 pip install nrdash
 ```
 
+!!! note
+    New Relic Dashboard Builder only works with Python 3.6 or higher.
+
 ## Usage
 
-To use New Relic Dashboard Builder, you must first acquire an [**admin** New Relic API key](https://docs.newrelic.com/docs/insights/insights-api/manage-dashboards/insights-dashboard-api#requirements). Once you have an admin API key, you can provide the admin API key and your dashboard configuration YAML file to the  New Relic Dashboard Builder command line tool.
+To use New Relic Dashboard Builder, you must first acquire an [**admin** New Relic API key](https://docs.newrelic.com/docs/insights/insights-api/manage-dashboards/insights-dashboard-api#requirements). Once you have an admin API key, you can configure your New Relic dashboards using the definitions in the YAML definition file by running the `nrdash` command line tool.
 
 ```sh
 nrdash --api-key <YOUR_ADMIN_API_KEY> --account-id <YOUR_ACCOUNT_ID> <DASHBOARD_DEFINITION_YAML_FILE>
 ```
-
-!!! note
-    You must use an admin API key, not an account level API key to manage dashboards with New Relic Dashboard builder
diff --git a/docs/reference.md b/docs/reference.md
@@ -15,6 +15,9 @@ Options:
   --help                Show this message and exit.
 ```
 
+!!! note
+    New Relic Dashboard Builder must use an admin API key, not an account level API key
+
 ## Dashboards
 
 Dashboards definitions are specified under the `dashboards` section. The dashboard title is used to uniquely identify each dashboard in an account. Any existing dashboards on the account with the same title will be overwritten with the definition in the configuration file. A new dashboard will be created if no dashboards exist with the title.