Skip to content

Commit

Permalink
Add warning at top of readme (elastic#123)
Browse files Browse the repository at this point in the history
* Add warning at top of readme: elastic#122 is the reason I decided to add this HTML comment warning about the readme :-)

* Perform fix proposed in elastic#122.

Closes elastic#122
  • Loading branch information
webmat authored and ruflin committed Sep 24, 2018
1 parent 78ad17a commit 189b13a
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 2 deletions.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
<!--
WARNING: README.md is generated based on the files under docs/
and the field descriptions in the YAML files under schemas/.
Therefore if you want to modify anything in this readme, please perform
your changes in these other locations, then run `make`.
See CONTRIBUTING.md for more details on setting up.
-->

**WARNING: THIS IS WORK IN PROGRESS**

# Elastic Common Schema (ECS)
Expand Down Expand Up @@ -584,7 +596,7 @@ In Beats, you can simplify the creation of events. For example, you can treat ea

### Disadvantage of dot notation

In Elasticsearch, each key can only have one type. For example, if `user` is an `object`, you can't use it as a`keyword` type in the same index, like `{"user": "nicolas ruflin"}`. This restriction can be an issue in certain datasets. For the ECS data itself, this is not an issue because all fields are predefined.
In Elasticsearch, each key can only have one type. For example, if `user` is an `object`, you can't use it as a `keyword` type in the same index, like `{"user": "nicolas ruflin"}`. This restriction can be an issue in certain datasets. For the ECS data itself, this is not an issue because all fields are predefined.

### What if I already use the underline notation?

Expand Down
2 changes: 1 addition & 1 deletion docs/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ In Beats, you can simplify the creation of events. For example, you can treat ea

### Disadvantage of dot notation

In Elasticsearch, each key can only have one type. For example, if `user` is an `object`, you can't use it as a`keyword` type in the same index, like `{"user": "nicolas ruflin"}`. This restriction can be an issue in certain datasets. For the ECS data itself, this is not an issue because all fields are predefined.
In Elasticsearch, each key can only have one type. For example, if `user` is an `object`, you can't use it as a `keyword` type in the same index, like `{"user": "nicolas ruflin"}`. This restriction can be an issue in certain datasets. For the ECS data itself, this is not an issue because all fields are predefined.

### What if I already use the underline notation?

Expand Down
12 changes: 12 additions & 0 deletions docs/intro.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
<!--
WARNING: README.md is generated based on the files under docs/
and the field descriptions in the YAML files under schemas/.
Therefore if you want to modify anything in this readme, please perform
your changes in these other locations, then run `make`.
See CONTRIBUTING.md for more details on setting up.
-->

**WARNING: THIS IS WORK IN PROGRESS**

# Elastic Common Schema (ECS)
Expand Down

0 comments on commit 189b13a

Please sign in to comment.