]> git.p6c8.net - policy-templates.git/commitdiff
warning about comments in .json more clear
authorBrandon Kurtz <kurtz.brandon@gmail.com>
Tue, 5 Jun 2018 20:20:37 +0000 (16:20 -0400)
committerGitHub <noreply@github.com>
Tue, 5 Jun 2018 20:20:37 +0000 (16:20 -0400)
I have no particular preference for the wording; just trying to make the warning more clear. This warning is hard to spot, yet important for folks without json experience.

README.md

index 1d3614f8c67108227c9003ac12d5d8c6f8b737d1..70864dbb76ae7a47864acedb0e128df045d588a4 100644 (file)
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@ The content of the JSON file should look like this:
   }
 }
 ```
   }
 }
 ```
-Policies are documented below. Note that even though comments are used in this file for documentation, comments are not allowed for JSON files.
+Policies are documented below. **Note**: though comments are used in this readme file for documentation, comments are not valid in actual JSON files. Remove all comments before attempting to deploy.
 
 Some of the policies are only available on the ESR for security reasons. These policies are marked ESR only.
 
 
 Some of the policies are only available on the ESR for security reasons. These policies are marked ESR only.
 

patrick-canterino.de