From: Brandon Kurtz Date: Tue, 5 Jun 2018 20:20:37 +0000 (-0400) Subject: warning about comments in .json more clear X-Git-Tag: v1.2~34^2~1 X-Git-Url: https://git.p6c8.net/policy-templates.git/commitdiff_plain/dbf3d5a174f91be894eb1dff20a2940e248a2009?hp=a9f83c781a6059d8e7fda7579e76fe5dd836b974 warning about comments in .json more clear 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. --- diff --git a/README.md b/README.md index 1d3614f..70864db 100644 --- 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.