Commit Graph

23 Commits

Author SHA1 Message Date
James Rodewig 693807a6d3
[DOCS] Fix double spaces (#71082) 2021-03-31 09:57:47 -04:00
James Rodewig b2cd89ec09
[DOCS] Split enrich examples from enrich tutorial (#71001) 2021-03-29 12:54:08 -04:00
James Rodewig fa93666b6a
[DOCS] Document ingest processor description (#70899) 2021-03-26 09:42:46 -04:00
James Rodewig 224bf7943a
[DOCS] Move enrich policy object def to API docs (#70825) 2021-03-25 09:17:41 -04:00
James Rodewig 5c75d004fa
[DOCS] Replace `put` with `create or update` in API names (#70330)
Co-authored-by: debadair <debadair@elastic.co>
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2021-03-15 14:49:44 -04:00
James Rodewig 010a973018
[DOCS] Refactor ingest pipeline docs (#70253) 2021-03-15 12:22:57 -04:00
James Rodewig 8d4ef1e38e
[DOCS] Update ingest pipeline xrefs (#70178) 2021-03-10 08:28:19 -05:00
James Rodewig 441c3a21b1
[DOCS] Update my-index examples (#60132)
Changes the following example index names to `my-index-000001` for consistency:

* `my-index`
* `my_index`
* `myindex`
2020-07-27 14:46:39 -04:00
James Rodewig 2774cd6938
[DOCS] Swap `[float]` for `[discrete]` (#60124)
Changes instances of `[float]` in our docs for `[discrete]`.

Asciidoctor prefers the `[discrete]` tag for floating headings:
https://asciidoctor.org/docs/asciidoc-asciidoctor-diffs/#blocks
2020-07-23 11:48:22 -04:00
James Rodewig 80b674fb25
[DOCS] Reformat snippets to use two-space indents (#59973) 2020-07-21 12:24:26 -04:00
DeDe Morton b5e374d958
[DOCS] Change Beats links to refactored getting started docs (#58790) 2020-07-02 17:10:09 -07:00
Lisa Cawley 8b9293b3bf
[DOCS] Replace docdir attribute with es-repo-dir (#57489) 2020-06-01 15:55:05 -07:00
James Rodewig 2f930f1ec0
[DOCS] Correct `query` datatype in enrich policy definition (#56224)
Corrects the datatype for the `query` property of an enrich policy
object. The `query` property is a query object, not a string.
2020-05-13 08:34:22 -04:00
James Rodewig bc7643c65b
[DOCS] Reduce content reuse in enrich docs (#53460)
Restructures the 'Update an enrich policy' section to:

* Migrate the content to the section. It was previously stored in the
  Put Enrich Policy API docs.
* Remove the warning tag admonition from the section content.
* Replace a reused section earlier in the "Set up an enrich processor"
  page with a link.

No substantive changes were made to the content.
2020-03-12 05:40:57 -04:00
James Rodewig 37baa50815
[DOCS] Explicitly document enrich `target_field` includes `match_field` (#49407)
When the enrich processor appends enrich data to an incoming document,
it adds a `target_field` to contain the enrich data.

This `target_field` contains both the `match_field` AND `enrich_fields`
specified in the enrich policy.

Previously, this was reflected in the documented example but not
explicitly stated. This adds several explicit statements to the docs.
2019-12-02 09:12:21 -05:00
James Rodewig 71ca343874
[DOCS] Clean up example pipeline and enrich policy in docs snippets (#49341) 2019-11-19 17:02:58 -05:00
James Rodewig c9e9685bfd
[DOCS] Add high-level docs for enrich processor and policies (#49194)
* [DOCS] Add high-level docs for enrich policies

* fix typos

* fix typo

* add warning for enrich policy changes

* add addtl cross-links to execute API docs

* Reword match and geo_match policy example headings
2019-11-19 13:56:51 -05:00
Martijn van Groningen ddf3bc25d8
Change how `max_matches` affects `target_field` option. (#47982)
Prior to this change the `target_field` would always be a json array
field in the document being ingested. This to take into account that
multiple enrich documents could be inserted into the `target_field`.

However the default `max_matches` is `1`. Meaning that by default
only a single enrich document would be added to `target_field` json
array field.

This commit changes this; if `max_matches` is set to `1` then the single
document would be added as a json object to the `target_field` and
if it is configured to a higher value then the enrich documents will be
added as a json array (even if a single enrich document happens to be
enriched).
2019-10-14 21:04:47 +02:00
James Rodewig 17eef81f83
[DOCS] Add docs for `geo_match` enrich policy type (#47745) 2019-10-09 08:39:11 -04:00
James Rodewig 2d77751716 [DOCS] Minor editorial changes to enrich docs 2019-09-23 13:23:57 -04:00
Martijn van Groningen 1118da0199
fixed tests 2019-09-23 11:08:58 +02:00
James Rodewig 2fbaf32412
[DOCS] Change // CONSOLE comments to [source,console] (#46669) 2019-09-12 10:13:21 -04:00
James Rodewig a97ed3e92b
[DOCS] Update "Enrich your data" tutorials (#46417)
* Move enrich docs to separate file

* Rewrite enrich processor tutorial
2019-09-09 08:44:56 -04:00