Commit Graph

22 Commits

Author SHA1 Message Date
James Rodewig 6078349106
[DOCS] Update index template API docs for data stream aliases (#75688)
With #73867, you can use component and index templates to add data stream
aliases.
2021-07-26 14:42:54 -04:00
James Rodewig f1e1661088
[DOCS] Reuse `aliases` object properties in API docs (#73421)
Changes:
* Reuses the same `aliases` object properties in the following API docs:
  * Clone index API
  * Create index API
  * Put component template API
  * Put legacy index template API
  * Put index template API
  * Rollover index API
  * Shrink index API
  * Simulate template API
  * Split index API
* Updates the `aliases` object properties for the simulate index API docs.

Closes #73044
2021-06-02 08:31:42 -04:00
James Rodewig 39a0314d30
[DOCS] Update alias xrefs (#73380)
Updates several internal 'alias' xrefs to point to the aliases guide rather than
API docs.
2021-05-25 16:19:00 -04:00
James Rodewig 6c5ab8c04c
[DOCS] Fix data stream ref in index template docs (#73292)
Updates an outdated reference to empty `data_stream` objects. The create index
template API's `data_stream` parameter now supports the `hidden` property.
2021-05-20 15:42:54 -04:00
James Rodewig 41a9eae803
[DOCS] Update `hidden` anchor (#73287) 2021-05-20 14:40:10 -04:00
James Rodewig cb943dbe9b
[DOCS] Reuse index template body params in simulate template API (#73177)
Changes:

* Reuses and reorders the index template API's body parameters in the simulate template API docs.
* Replaces several includes with a shorter xref.
* Reformats a sidebar on naming collisions with built-in index templates.
2021-05-20 12:21:20 -04:00
Pierre Grimaud 3c44dfec60
[DOCS] Fix typos (#72227) 2021-04-26 12:40:38 -04:00
James Rodewig f41320616c
[DOCS] Refactor data stream setup tutorial (#71074) 2021-03-31 17:28:55 -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 ebf08c0c83
[DOCS] Reuse built-in index templates admon (#68314) 2021-02-01 12:34:21 -05:00
James Rodewig 81c3cba8a8
[DOCS] Add security privileges to index API docs (#68071) 2021-01-28 08:53:10 -05:00
James Rodewig 518d71d1e3
[DOCS] Document hidden data streams and naming restrictions (#65862) 2021-01-13 09:09:15 -05:00
James Rodewig da0188fb45
[DOCS] Fix Fleet links (#66553) (#66557) 2020-12-17 15:27:15 -05:00
DeDe Morton fb53dc3167
Fix links to Fleet overview (#65174) 2020-11-18 10:26:04 -08:00
James Rodewig 1ea83359bb
[DOCS] Fix case for 'Boolean' (#64299) 2020-10-29 09:04:43 -04:00
Lee Hinman d21ddb57a3
Add "synthetics-*-*" templates for synthetics fleet data (#62193)
* Add "synthetics-*-*" templates for synthetics fleet data

For the Elastic Agent we currently have `logs` and `metrics`, however, synthetic data doesn't belong
with those and thus we should have a place for it to live. This would be data reported from
heartbeat and under the 'monitoring' category.

This commit adds a composable index template for `synthetics-*-*` indices similar to the work in
 #56709 and #57629.

Resolves #61665
2020-09-14 16:37:21 -06:00
James Rodewig a405002b39
[DOCS] Update admon for built-in templates (#61549) (#61559) 2020-08-26 08:10:49 -04:00
James Rodewig cd6304ae6b
[DOCS] Add admon for built-in index templates (#61063)
Adds an important admonition for the built-in `metrics-*-*` and `logs-*-*` index
templates.

Updates several put index template snippets to include a priority.
2020-08-17 11:37:08 -04:00
James Rodewig ae01606785
[DOCS] Replace `twitter` dataset in docs (#60604) 2020-08-03 12:49:56 -04:00
James Rodewig 724f706f89
[DOCS] Replace `twitter` dataset in docs APIs (#60521) 2020-07-31 11:52:26 -04:00
James Rodewig 4ebf0cddc0
[DOCS] Fix `template` param in put index template API (#60474) 2020-07-30 14:54:22 -04:00
debadair db0adfd2b8
[DOCS] Refactored index-templates topic. (#59737)
* [DOCS] Refactored index-templates topic.

* [DOCS] Add separate files.

* [DOCS] Add delete component template.

* Apply suggestions from code review

Co-authored-by: James Rodewig <james.rodewig@elastic.co>

* [DOCS] Incorporated review comments
2020-07-23 19:02:11 -07:00