elasticsearch/docs/reference
David Turner 0534fbada8
Clarify 'runs in the foreground' (#76709)
Users following the installation guide sometimes get stuck, reporting
that Elasticsearch has "hung" after running `./bin/elasticsearch`
because it doesn't exit, it just sits there in the foreground waiting
for something to happen. We do say that it "runs in the foreground" in
the docs but that's not clear enough, maybe folks expect it to declare
it started up successfully or to open a browser window for them or
something.

This commit expands the docs to clarify what users should expect from
running Elasticsearch from the command line and what they should do
next.
2021-09-06 12:29:18 +01:00
..
aggregations Adds support for the rate aggregation under a composite agg (#76992) 2021-09-01 07:29:13 -04:00
analysis change a typo in first letter of a user query (#76394) (#76450) 2021-08-12 14:28:51 -04:00
autoscaling Autoscale frozen tier into existence (#73435) 2021-06-22 13:21:04 +02:00
cat Remove usage of RAM accounting of segments (#75674) 2021-07-29 08:36:09 +02:00
ccr [DOCS] Remove screenshot from managing CCR (#76193) 2021-08-05 15:57:51 -04:00
cluster Add timing stats to publication process (#76771) 2021-08-23 17:38:32 +01:00
commands Reset elastic password cli tool (#74892) 2021-07-20 13:42:14 +03:00
data-management [DOCS] How to migrate to node roles from node attrs. Closes #65855 (#71160) 2021-04-27 14:39:54 -07:00
data-streams [DOCS] Remove 'step' from headings (#76753) 2021-08-20 08:52:04 -04:00
docs [DOCS] Change `_routing` to `routing` in mget API docs (#76214) (#76304) 2021-08-10 13:08:50 -04:00
eql [DOCS] EQL: Remove multi-value field limitation (#76663) 2021-08-19 09:20:48 -04:00
features/apis Make feature reset API response more informative (#71240) 2021-04-27 13:47:10 -04:00
fleet [DOCS] Relocate tip for Fleet APIs 2021-07-26 18:14:05 -04:00
graph [DOCS] Fix API titles (#67475) 2021-01-13 15:15:37 -05:00
high-availability [DOCS] Replace 'log into' with 'log in to' (#72324) 2021-04-27 15:27:22 -04:00
how-to [DOCS] Remove 'step' from headings (#76753) 2021-08-20 08:52:04 -04:00
ilm [DOCS] Add ILM error/troubleshooting info. Closes #75849 (#76957) 2021-08-26 15:44:50 -04:00
images [DOCS] Update index management screenshots for new EUI theme (#75754) 2021-07-27 14:51:24 -04:00
index-modules [DOCS] Fix typo (#75635) (#75705) 2021-07-26 18:05:22 -04:00
indices Keep track of data recovered from snapshots in RecoveryState (#76499) 2021-08-16 18:18:37 +02:00
ingest Add enrich node cache (#76800) 2021-09-03 09:33:44 +02:00
licensing [DOCS] Note get license API can return a `404` (#73951) 2021-06-10 09:19:20 -04:00
mapping [DOCS] Clarify indexing a runtime field (#77117) 2021-09-01 11:59:11 -04:00
migration Enable LZ4 transport compression by default (#76326) 2021-08-17 12:19:42 -06:00
ml [ML] adding new defer_definition_decompression parameter to put trained model API (#77189) 2021-09-03 09:07:54 -04:00
modules [DOCS] Fix formatting for `snapshot_meta` thread pool (#76973) 2021-08-26 10:36:26 -04:00
monitoring update monitoring cluster node name (#74500) 2021-06-28 09:30:55 -04:00
query-dsl [DOCS] Update combined fields wording (#76893) 2021-08-26 13:16:55 -04:00
release-notes 8.0.0-alpha1 BC3 release note update (#76123) 2021-08-04 17:09:59 -05:00
repositories-metering-api [DOCS] Fix name of `cluster_version` parameter (#69615) 2021-03-01 08:54:47 -05:00
rest-api Node shutdown API docs (#74505) 2021-08-19 12:42:27 -04:00
rollup Fix privileges for GetRollupIndexCapabilities API (#75614) 2021-07-29 11:57:42 +10:00
scripting [DOCS] Add ES security principles (#76850) 2021-08-31 12:37:22 -04:00
search [DOCS] Fix the terms enum API docs for search_after (#76991) 2021-08-26 14:07:06 -04:00
searchable-snapshots [DOCS] Fix typo in mount searchable snapshots API docs (#75786) (#75984) 2021-08-02 14:46:43 -04:00
settings [DOCS] Fix formatting for Watcher settings (#76491) 2021-08-13 08:33:10 -04:00
setup Clarify 'runs in the foreground' (#76709) 2021-09-06 12:29:18 +01:00
shutdown/apis Node shutdown API docs (#74505) 2021-08-19 12:42:27 -04:00
slm [DOCS] Reuse snapshot config in put SLM policy API docs (#76712) 2021-08-20 08:29:16 -04:00
snapshot-restore Implement Sort By Repository Name in Get Snapshots API (#77049) 2021-09-01 13:01:58 +02:00
sql SQL: Fix disjunctions (and `IN`) with multiple date math expressions (#76424) 2021-08-31 17:30:49 +02:00
tab-widgets [DOCS] Fix typos (#76875) 2021-08-24 08:47:12 -04:00
text-structure/apis [ML] [DOCS] update find-structure reference docs (#67586) 2021-01-15 12:19:38 -05:00
transform [Transform] Implement the ability to preview the existing transform (#76697) 2021-08-24 14:41:49 +02:00
upgrade [DOCS] Fix upgrade version logic for `-alpha` and `-beta` releases (#76727) 2021-08-20 08:29:35 -04:00
vectors Add access to dense_vector values (#71313) 2021-04-19 08:02:05 -04:00
aggregations.asciidoc Convert bucket aggs docs to runtime fields (#71202) 2021-04-02 12:12:06 -04:00
alias.asciidoc [DOCS] Updates for data stream aliases (#75654) 2021-07-26 08:29:20 -05:00
analysis.asciidoc [DOCS] Fix Lucene's stop words links (#70405) 2021-03-16 17:06:12 -04:00
api-conventions.asciidoc [DOCS] Adds information about version compatibility headers (#77096) 2021-09-03 14:33:23 -07:00
cat.asciidoc [DOCS] Remove unneeded escapes 2021-04-26 12:14:45 -04:00
cluster.asciidoc [DOCS] Reword node roles docs (#69301) 2021-02-23 11:32:46 -05:00
data-management.asciidoc [DOCS] Move Kibana index mgmt docs to ES (#64380) 2020-10-30 09:14:52 -04:00
data-rollup-transform.asciidoc [DOCS] Remove ifdefs for rollup refactor 2021-08-05 09:08:04 -04:00
datatiers.asciidoc [DOCS] Note required node roles and data tiers (#74566) 2021-07-07 09:57:32 -04:00
dependencies-versions.asciidoc [DOCS] Added appendix to show dependencies (#67962) 2021-01-26 16:16:05 -08:00
docs.asciidoc [DOCS] Update single index APIs reference (#73103) 2021-05-14 11:53:34 -04:00
getting-started.asciidoc [DOCS] Remove 'step' from headings (#76753) 2021-08-20 08:52:04 -04:00
gs-index.asciidoc
high-availability.asciidoc [DOCS] Add docs for designing resilient clusters (#47233) 2020-06-05 11:48:44 -04:00
how-to.asciidoc [DOCS] Add 'Fix common cluster issues' docs (#72097) 2021-04-28 08:28:51 -04:00
index-extra-title-page.html
index-modules.asciidoc Move `index.hidden` from Static to Dynamic settings (#77218) 2021-09-03 09:15:52 -06:00
index.asciidoc [DOCS] Move ES glossary to Stack docs (#74579) 2021-06-24 19:04:31 -04:00
index.x.asciidoc
indices.asciidoc [DOCS] Fix broken doc url values in JSON API spec (#75385) 2021-07-15 13:46:00 -04:00
ingest.asciidoc [DOCS] Document regex circuit breaker (#76048) 2021-08-04 16:37:29 -04:00
intro.asciidoc [DOCS] Fix links to anomaly detection overview (#74943) 2021-07-05 13:19:54 -07:00
links.asciidoc [DOCS] Rename ES Reference to ES Guide (#71198) 2021-04-01 15:38:41 -04:00
mapping.asciidoc Minor revision missed in merge. (#67282) 2021-01-11 13:50:06 -05:00
query-dsl.asciidoc [DOCS] Remove deprecated `geo_shape` parameters (#74519) 2021-06-29 08:52:05 -04:00
redirects.asciidoc [DOCS] Add ES security principles (#76850) 2021-08-31 12:37:22 -04:00
release-notes.asciidoc
scripting.asciidoc [DOCS] Move common scripting use cases up a level (#73445) 2021-05-27 07:38:55 -04:00
search.asciidoc [DOCS] Document `_mvt` API (#75384) 2021-08-05 15:04:07 -04:00
setup.asciidoc [DOCS] Edit JVM settings info. Closes #72259 (#72350) 2021-04-28 18:30:32 -07:00
upgrade.asciidoc [DOCS] Fix upgrade version logic for `-alpha` and `-beta` releases (#76727) 2021-08-20 08:29:35 -04:00