From 001d1944348d9e8ada9d68e4b3f80e611f0e2386 Mon Sep 17 00:00:00 2001 From: Mathieu Martin Date: Wed, 7 Nov 2018 16:16:26 -0500 Subject: [PATCH] Add warning about the readme superseding the other generated files as the spec --- README.md | 6 ++++++ docs/intro.md | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/README.md b/README.md index a4d1c1a479..549a6331d1 100644 --- 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 index 1c4ee49ea0..40e342cf9e 100644 --- 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)