Add warning about the readme superseding the other generated files as…

… the spec
elastic · Nov 7, 2018 · 001d194 · 001d194
1 parent 7924db7
commit 001d194
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -30,6 +30,12 @@ The master branch of this repository should never be considered an
 official release of ECS. You can browse official releases of ECS
 [here](https://github.com/elastic/ecs/releases).
 
+Please note that when the README.md file and other generated files
+(like schema.csv and template.json) are not in agreement,
+the README.md should be considered the official spec.
+The other two files are simply provided as a convenience, and may not always be
+fully up to date.
+
 # In this readme
 
 * [Fields](#fields)

diff --git a/docs/intro.md b/docs/intro.md
@@ -30,6 +30,12 @@ The master branch of this repository should never be considered an
 official release of ECS. You can browse official releases of ECS
 [here](https://github.com/elastic/ecs/releases).
 
+Please note that when the README.md file and other generated files
+(like schema.csv and template.json) are not in agreement,
+the README.md should be considered the official spec.
+The other two files are simply provided as a convenience, and may not always be
+fully up to date.
+
 # In this readme
 
 * [Fields](#fields)