Commit graph

152 commits

Author SHA1 Message Date
shainaraskas
e581ae3482
Reorder docs sidebar (#115360) 2024-10-23 12:57:59 -04:00
Liam Thompson
6e400c12a7
[DOCS] Port connector docs from Enterprise Search guide (#112953) 2024-09-30 10:22:37 +02:00
Liam Thompson
4f666310c7
[DOCS] Create Elasticsearch basics section, refactor quickstarts section (#112436)
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
2024-09-25 17:30:01 +02:00
Liam Thompson
163b2c781f
[DOCS] Fix reranking IA, move retrievers to search api overview (#112949) 2024-09-19 17:20:52 +02:00
Liam Thompson
d0f4966431
[DOCS] Add local dev setup instructions (#107913)
* [DOCS] Add local dev setup instructions

- Replace existing Run ES in Docker locally page, with simpler no-security local dev setup
- Move this file into Quickstart folder, along with existing quickstart guide
- Update self-managed instructions in Quickstart guide to use local dev approach
2024-05-07 18:10:48 +02:00
Liam Thompson
33a71e3289
[DOCS] Refactor book-scoped variables in docs/reference/index.asciidoc (#107413)
* Remove `es-test-dir` book-scoped variable

* Remove `plugins-examples-dir` book-scoped variable

* Remove `:dependencies-dir:` and `:xes-repo-dir:` book-scoped variables

- In `index.asciidoc`, two variables (`:dependencies-dir:` and `:xes-repo-dir:`) were removed.
- In `sql/index.asciidoc`, the `:sql-tests:` path was updated to fuller path
- In `esql/index.asciidoc`, the `:esql-tests:` path was updated idem

* Replace `es-repo-dir` with `es-ref-dir`

* Move `:include-xpack: true` to few files that use it, remove from index.asciidoc
2024-04-17 14:37:07 +02:00
Liam Thompson
d44e05d2c2
[DOCS] Add ES quickstart (#102226)
* [DOCS] TEST restore quickstart

* Use up to date Docker instructions, minor user-friendly modifications

* Use books dataset, update verbiage, add examples

* Update verbiage

* Updated Elasticsearch 'Getting Started' docs: added SSL, Docker setup, Python resources, and expanded next steps

* minor formatting

* Collapse responses, TODO comment tests

* Add request tests

* Edit superfluities

* Apply suggestions

Co-authored-by: István Zoltán Szabó <istvan.szabo@elastic.co>

* Update docs/reference/tab-widgets/quick-start-install.asciidoc

Co-authored-by: István Zoltán Szabó <istvan.szabo@elastic.co>

---------

Co-authored-by: István Zoltán Szabó <istvan.szabo@elastic.co>
2023-11-24 15:27:41 +01:00
James Rodewig
255c9a7f95
[DOCS] Move x-pack docs to docs/reference dir (#99209)
**Problem:**
For historical reasons, source files for the Elasticsearch Guide's security, watcher, and Logstash API docs are housed in the `x-pack/docs` directory. This can confuse new contributors who expect Elasticsearch Guide docs to be located in `docs/reference`. 

**Solution:**
- Move the security, watcher, and Logstash API doc source files to the `docs/reference` directory
- Update doc snippet tests to use security

Rel: https://github.com/elastic/platform-docs-team/issues/208
2023-09-12 14:53:41 -04:00
Chris Hegarty
c300712dfe
Remove docs workaround (#98346)
This commit removes a temporary workaround that was added for the doc root.
2023-08-10 13:54:04 +01:00
Costin Leau
1f77e2ba56 Merge commit '6d45c57b8f' into esql/lang 2023-07-08 15:53:01 +03:00
James Rodewig
0781e60b19
[DOCS] Add TOC to landing page (#97437)
- Adds the TOC to the Elasticsearch docs landing page. Removes the right sidebar from the landing page.
- Removes the "View all Elastic docs" link from the bottom of the landing page

Co-authored-by: Abdon Pijpelink <abdon.pijpelink@elastic.co>
2023-07-07 07:44:12 -04:00
elasticsearchmachine
ae12d77f32 Merge pull request ESQL-1173 from elastic/main
🤖 ESQL: Merge upstream
2023-05-24 13:16:43 -04:00
debadair
777598d602
[DOCS] Remove redirect pages (#88738)
* [DOCS] Remove manual redirects

* [DOCS] Removed refs to modules-discovery-hosts-providers

* [DOCS] Fixed broken internal refs

* Fixing bad cross links in ES book, and adding redirects.asciidoc[] back into docs/reference/index.asciidoc.

* Update docs/reference/search/point-in-time-api.asciidoc

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

* Update docs/reference/setup/restart-cluster.asciidoc

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

* Update docs/reference/sql/endpoints/translate.asciidoc

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

* Update docs/reference/snapshot-restore/restore-snapshot.asciidoc

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

* Update repository-azure.asciidoc

* Update node-tool.asciidoc

* Update repository-azure.asciidoc

---------

Co-authored-by: amyjtechwriter <61687663+amyjtechwriter@users.noreply.github.com>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
Co-authored-by: Amy Jonsson <amy.jonsson@elastic.co>
Co-authored-by: James Rodewig <james.rodewig@elastic.co>
2023-05-24 12:32:46 +01:00
Nik Everett
02e8293f54 Add shell for ESQL docs (ESQL-913)
This adds a super basic shell for the esql docs. You can build them with
the standard docs build commend:
```
../docs/build_docs --doc docs/reference/index.asciidoc \
  --resource x-pack/docs/ --chunk 1 --open
```
2023-03-23 13:53:43 -04:00
Nathan Reese
734b2cdfec
Add Geospatial analysis overview documentation (#94486)
* Geospatial analysis top level documenation

* ml and alerting sections

* ingest

* aggregate

* cleanup

* eruption dashboard

* describe dashboard image

* intro

* query

* add to index page

* Update docs/reference/geospatial-analysis.asciidoc

Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>

* Update docs/reference/geospatial-analysis.asciidoc

Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>

* fix geo_point and geo_shape reference

* fix terms aggregation reference

* Fix typo

* Improve doc structure to resolve docs build errors

* Move page up in TOC

* Add geospational analysis to landing page

---------

Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>
Co-authored-by: Abdon Pijpelink <abdon.pijpelink@elastic.co>
2023-03-20 10:01:13 -06:00
debadair
b6eb971fdc
[DOCS] Remove ES quickstart. (#87939)
* [DOCS] Remove ES quickstart.

* Fix xref

* Fix xrefs

* Add redirect
2022-06-23 14:25:48 -07:00
Andrei Dan
21785c9a77
How-to docs for increasing the total number of shards per node (#86214)
Co-authored-by: Lee Hinman <dakrone@users.noreply.github.com>
Co-authored-by: Leaf-Lin <39002973+Leaf-Lin@users.noreply.github.com>
2022-05-10 09:13:27 +01:00
Dan Roscigno
37beabcb2e
reorder and merge data management and ILM doc pages (#84679)
* reorder and merge data management and ILM doc pages

* update abbreviated titles
2022-03-07 18:33:28 -05:00
James Rodewig
2fe07014d9
[DOCS] Move ES glossary to Stack docs (#74579)
The ES glossary is now incorporated into the [Elastic glossary](https://www.elastic.co/guide/en/elastic-stack-glossary/current/terms.html).

Depends on https://github.com/elastic/stack-docs/pull/1722 and https://github.com/elastic/docs/pull/2141
2021-06-24 19:04:31 -04:00
Rene Groeschke
94f07c4942
Fix docs path for docs PR to pass 2021-06-01 16:55:13 +02:00
James Rodewig
b1ad71b077
[DOCS] Add alias guide (#73062)
Creates a guide for aliases. We can use this guide to house concepts, examples,
and tips for aliases.
2021-05-25 11:52:16 -04:00
James Rodewig
8dddca77aa
[DOCS] Remove and redirect frozen index overview content (#72990)
Changes:

* Removes and adds redirects for the frozen indices [overview][0], [best
  practices][1], [search][2], and [monitoring][3] pages.
* Removes glossary terms related to frozen indices.
* Updates several xrefs to point to the freeze index API docs.

Relates to elastic/elasticsearch#72946 and elastic/elasticsearch#70192.

[0]: https://www.elastic.co/guide/en/elasticsearch/reference/7.12/frozen-indices.html
[1]: https://www.elastic.co/guide/en/elasticsearch/reference/master/best_practices.html
[2]: https://www.elastic.co/guide/en/elasticsearch/reference/master/searching_a_frozen_index.html
[3]: https://www.elastic.co/guide/en/elasticsearch/reference/master/monitoring_frozen_indices.html
2021-05-12 12:54:20 -04:00
James Rodewig
2dd034bc65
[DOCS] Rename ES Reference to ES Guide (#71198) 2021-04-01 15:38:41 -04:00
debadair
af87716c50
[DOCS] Added appendix to show dependencies (#67962) 2021-01-26 16:16:05 -08:00
Henning Andersen
c91a4d8d2b
Autoscaling remove feature flags (#65973)
Removed the autoscaling feature flags, autoscaling is now on by default
(though it requires an external system to handle the autoscaling
events). Added experimental notice to all autoscaling related
documentation pages.

Relates #51191
2020-12-14 19:06:09 +01:00
debadair
43a503f3dc
[DOCS] Add top-level Data management section. (#64185)
* [DOCS] Add top-level Data management section.

* Edits

* Edits

* Fixed xrefs

* Apply suggestions from code review

Co-authored-by: Andrei Dan <andrei.dan@elastic.co>
Co-authored-by: Lee Hinman <dakrone@users.noreply.github.com>

* Update docs/reference/datatiers.asciidoc

* Update docs/reference/datatiers.asciidoc

Co-authored-by: Andrei Dan <andrei.dan@elastic.co>
Co-authored-by: Lee Hinman <dakrone@users.noreply.github.com>
2020-10-28 15:38:22 -07:00
Andrei Dan
d588cab747
DOCS: general overview of data tiers and roles (#63086)
This adds general overview documentation for data tiers, 
the data tiers specific node roles, and their application in
ILM.

Co-authored-by: Lee Hinman <dakrone@users.noreply.github.com>
Co-authored-by: debadair <debadair@elastic.co>
2020-10-07 17:06:54 +01:00
James Rodewig
fdc4e83050
[DOCS] Combine Search your data files (#61477)
No-op changes to:

* Move `Search your data` source files into the same directory
* Rename `Search your data` source files based on page ID
* Remove unneeded includes
* Remove the `Request` dir
2020-08-24 11:22:56 -04:00
James Rodewig
e0b5e576b5
[DOCS] Reorder ES TOC (#61231) 2020-08-19 08:26:51 -04:00
James Rodewig
dca46c29ff
[DOCS] Refactor EQL docs (#60700)
Changes:

* Moves sample data to reusable rest test
* Combines EQL index, requirements, and run a search pages
* Combines EQL syntax and limitations pages
* Adds related redirects
2020-08-05 10:11:02 -04:00
James Rodewig
f320567e5a
[DOCS] Merge search topic and overview pages (#60459) 2020-07-30 15:01:21 -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
Lisa Cawley
1781d4a7b9
[DOCS] Fix security links in machine learning APIs (#60098) 2020-07-23 12:14:56 -07:00
James Rodewig
747e61508a
[DOCS] EQL: Prepare docs for release (#59259)
Changes:

* Swaps the `dev` admonitions for `experimental` admonitions
* Removes `ifdef` statements preventing the docs from appearing in
  released branches
2020-07-13 08:40:38 -04:00
debadair
f80f603c1e
[DOCS] Combo version of ILM docs. (#57909)
* [DOCS] Combo version of ILM docs.

* [DOCS] Moved tutorial from Kibana.

* Adds documentation for index lifecycle policies (#28705)

* [DOCS] Adds documentation for index lifecycle policies

* [DOCS] Updated image for policy options to show all menu items

* Update create-policy.asciidoc

* [DOCS] Incorporated review comments on hot and warm phase

* [DOCS] Additional changes to warm phase

* [DOCS] Removed the word open in the warm phase

* Adds X-Pack icon for ILM (#34178)

* Add ILM tutorial (#59502)

* Add tutorial for ILM with filebeat

* Change screenshots and add additional steps

* Update screenshots, add numbered steps, and other minor edits

* Incorporate feedback: update links, formatting, and minor edits

* Move tip inline with list

* Apply suggestions from code review

Co-Authored-By: James Rodewig <james.rodewig@elastic.co>

* Move TIP inline . . . again

* Put TIP inline

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

* Updates for navigation redesign (#68709)

* [DOCS] Updates for navigation redesign

* Getting started

* Set up text

* Discover

* Dashboard, Graph, ML, Maps, APM, SIEM, Dev tools

* Dev Tools, Stack Monitoring, Management

* Management

* Final changes

* [DOCS] Updates for navigation redesign

* [DOCS] Updates CCR monitoring screenshots

* updates SIEM screenshot and Cases overview text

* Added Brandon's APM image

* [DOCS] Refines CCR shard screenshot

* Removed merge conflict image file

Co-authored-by: lcawl <lcawley@elastic.co>
Co-authored-by: Ben Skelker <ben.skelker@elastic.co>

* [DOCS] Put API examples in collapsible sections like ML does

* Fix include

* Added tutorial images

* Fixed images

* Add short title for FB tutorial

* Add missing files

* Incorporate review feedback

* review feedback

* Incorporated review feedback

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
Co-authored-by: Melori Arellano <melori@elastic.co>
Co-authored-by: James Rodewig <james.rodewig@elastic.co>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Ben Skelker <ben.skelker@elastic.co>
2020-07-03 12:40:31 -07:00
debadair
d756cd6866
[DOCS] Reformat release highlights as What's new. (#58074)
* [DOCS] Reformat release highlights as What's new.

* Removed line break.
2020-06-15 13:26:30 -07:00
James Rodewig
b1e28d9f84
[DOCS] Reformat data stream tutorial docs (#57883)
Creates a new page for a 'Set up a data stream' tutorial, based on
existing content in 'Data streams'.

Also adds tutorials for:

* Configuring an ILM policy for a data stream
* Indexing documents to a data stream
* Searching a data stream
* Manually rolling over a data stream
2020-06-10 13:40:54 -04:00
Martijn van Groningen
21450f3f5b
[DOCS] Add data stream overview and intro (#57596)
Added data streams overview page and
an introduction to data streams.

Relates to #53100

Co-authored-by: Dan Hermann <danhermann@users.noreply.github.com>
Co-authored-by: James Rodewig <james.rodewig@elastic.co>
2020-06-05 14:36:01 +02:00
Lisa Cawley
0f52cab495
[DOCS] Replaces docdir attributes in ML APIs (#57390) 2020-06-01 11:46:10 -07:00
James Rodewig
70cb519aa7
[DOCS] Relocate discovery module content (#56611)
* Moves `Discovery and cluster formation` content from `Modules` to
`Set up Elasticsearch`.

* Combines `Adding and removing nodes` with `Adding nodes to your
  cluster`. Adds related redirect.

* Removes and redirects the `Modules` page.

* Rewrites parts of `Discovery and cluster formation` to remove `module`
  references and meta references to the section.
2020-05-12 17:39:06 -04:00
James Rodewig
a73fef3d62
[DOCS] Create top-level "Search your data" page (#56058)
* [DOCS] Create top-level "Search your data" page

**Goal**

Create a top-level search section. This will let us clean up our search
API reference docs, particularly content from [`Request body search`][0].

**Changes**

* Creates a top-level `Search your data` page. This page is designed to
  house concept and tutorial docs related to search.

* Creates a `Run a search` page under `Search your data`. For now, This
  contains a basic search tutorial. The goal is to add content from
  [`Request body search`][0] to this in the future.

* Relocates `Long-running searches` and `Search across clusters` under
  `Search your data`. Increments several headings in that content.

* Reorders the top-level TOC to move `Search your data` higher. Also
  moves the `Query DSL`, `EQL`, and `SQL access` chapters immediately
  after.

Relates to #48194

[0]: https://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html
2020-05-05 09:46:29 -04:00
James Rodewig
e2fc95d97a
[DOCS] Remove 'Testing' chapter (#55270)
Removes the 'Testing' chapter from the Elasticsearch Reference guide.

This chapter was originally written for so that users using the Java HLRC client could
use the same test classes when testing Elasticsearch in their own applications.
However, this is no longer the case or recommended.

Closes #55257.
2020-04-21 10:04:14 -04:00
James Rodewig
600ccc0a51
[DOCS] Relocate "Plugins" page (#54974) 2020-04-10 15:29:44 -04:00
Luca Cavanna
0a93a93069
[DOCS] add docs for async search (#53675)
Relates to #49091

Co-Authored-By: James Rodewig <james.rodewig@elastic.co>
2020-03-20 14:04:33 +01:00
James Rodewig
c82a050eef [DOCS] Include docs on permanently unreleased branches only (#51743)
Adds the ability to display docs on permanently unreleased branches,
such as `master` and `7.x`.

Also updates how the autoscaling and EQL docs are included.
Currently, these feature-flag docs would display on any unreleased
branches that contain the changes, such as 7.7.
2020-02-11 11:22:49 -05:00
James Rodewig
d01f5fcc4a
Revert "[DOCS] Include docs on permanently unreleased branches only (#51743)" (#52066)
This reverts commit f21b6411a1.
2020-02-07 12:12:29 -05:00
James Rodewig
f21b6411a1
[DOCS] Include docs on permanently unreleased branches only (#51743)
Adds the ability to display docs on permanently unreleased branches,
such as `master` and `7.x`.

Also updates how the autoscaling and EQL docs are included.
Currently, these feature-flag docs would display on any unreleased
branches that contain the changes, such as 7.7.
2020-02-06 14:44:20 -05:00
James Rodewig
0a31b67cc5
[DOCS] Add top-level EQL docs page. Adds EQL requirements page. (#51334)
* Creates a top-level page for EQL in the ES reference.
   This page contains a high-level introduction and will include a nav for other EQL docs pages as they're built.

* Creates a requirements page.
  This page outlines the fields needed to use EQL in ES.
2020-01-27 16:03:23 -05:00
Jason Tedor
2f048cd1e7
Exclude autoscaling docs from release docs (#51190)
Since autoscaling is currently only under development, this commit
causes the autoscaling docs to be excluded any time that release docs
are being built.
2020-01-20 10:52:19 -05:00
Jason Tedor
d96038eca8
Initial autoscaling commit (#51161)
This commit merely adds the skeleton for the autoscaling project, adding
the basics to include the autoscaling module in the default
distribution, opt-in to code formatting, and a placeholder for the docs.
2020-01-17 14:54:53 -05:00