honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/reference/index.asciidoc

89 lines
2.3 KiB
Plaintext
Raw Normal View History

Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
[[elasticsearch-reference]]
Docs: Rename reference docs to Elasticsearch Reference
2015-05-22 08:49:11 -04:00
= Elasticsearch Reference
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
Bumped doc versions to 6.0.0-alpha1
2016-09-08 12:29:18 -04:00
:version: 6.0.0-alpha1
:major-version: 6.x
[docs] Document Docker installation method Initial commit of the Docker installation method for Elasticsearch. Relates #21497
2016-11-17 08:06:32 -05:00
:docker-image: docker.elastic.co/elasticsearch/elasticsearch:{version}
:x-pack-baseurl: https://www.elastic.co/guide/en/x-pack/5.0
Fixed released_state docs switch to build correctly and include missing links
2016-10-06 15:40:17 -04:00
//////////
release-state can be: released | prerelease | unreleased
//////////
Add placeholder to the docs to distinguish released from unreleased from prerelease versions (#20644) Closes https://github.com/elastic/stack/issues/18
2016-10-06 11:56:55 -04:00
:release-state: unreleased
Fix Lucene version in the docs.
2016-10-28 08:50:46 -04:00
:lucene_version: 6.3.0
Remove most of the need for `// NOTCONSOLE` and be much more stingy about what we consider a console candidate. * Add `// CONSOLE` to check-running * Fix version in some snippets * Mark groovy snippets as groovy * Fix versions in plugins * Fix language marker errors * Fix language parsing in snippets This adds support for snippets who's language is written like `[source, txt]` and `["source","js",subs="attributes,callouts"]`. This also makes language required for snippets which is nice because then we can be sure we can grep for snippets in a particular language.
2016-08-29 17:33:25 -04:00
:branch: master
:jdk: 1.8.0_73
:defguide: https://www.elastic.co/guide/en/elasticsearch/guide/master
:plugins: https://www.elastic.co/guide/en/elasticsearch/plugins/master
:javaclient: https://www.elastic.co/guide/en/elasticsearch/client/java-api/master/
:issue: https://github.com/elastic/elasticsearch/issues/
:pull: https://github.com/elastic/elasticsearch/pull/
Docs: Made current version, branch and jdk into asciidoc attributes
2014-07-23 05:54:53 -04:00
Generate reference links for painless API (#22775) Adds "Appending B. Painless API Reference", a reference of all classes and methods available from Painless. Removes links to java packages because they contain methods that we don't expose and don't contain methods that we do expose (the ones in Augmentation). Instead this generates a list of every class and every exposed method using the same type information available to the interpreter/compiler/whatever-we-call-it. From there you can jump to the relevant docs. Right now you build all the asciidoc files by running ``` gradle generatePainlessApi ``` These files are expected to be committed because we build the docs without running `gradle`. Also changes the output of `Debug.explain` so that it is easy to search for the class in the generated reference documentation. You can also run it in an IDE safely if you pass the path to the directory in which to generate the docs as the first parameter. It'll blow away the entire directory an recreate it from scratch so be careful. And then you can build the docs by running something like: ``` ../docs/build_docs.pl --out ../built_docs/ --doc docs/reference/index.asciidoc --open ``` That is, if you have checked out https://github.com/elastic/docs in `../docs`. Wait a minute or two and your browser will pop open in with all of Elasticsearch's reference documentation. If you go to `http://localhost:8000/painless-api-reference.html` you can see this list. Or you can get there by following the links to `Modules` and `Scripting` and `Painless` and then clicking the link in the paragraphs below titled `Appendix B. Painless API Reference`. I like having these in asciidoc because we can deep link to them from the rest of the guide with constructs like `<<painless-api-reference-Object-hashCode-0>>` and `<<painless-api-reference->>` and we get link checking. Then the only brittle link maintenance bit is the link generation for javadoc. Which sucks. But I think it is important that we link to the methods directly so they are easy to find. Relates to #22720
2017-01-26 10:39:19 -05:00
///////
Javadoc roots used to generate links from Painless's API reference
///////
:java8-javadoc: https://docs.oracle.com/javase/8/docs/api
:java9-javadoc: http://download.java.net/java/jigsaw/docs/api
:joda-time-javadoc: http://www.joda.org/joda-time/apidocs
:lucene-core-javadoc: http://lucene.apache.org/core/6_4_0/core
ifeval::["{release-state}"=="unreleased"]
:elasticsearch-javadoc: https://snapshots.elastic.co/javadoc/org/elasticsearch/elasticsearch/{version}-SNAPSHOT
:painless-javadoc: https://snapshots.elastic.co/javadoc/org/elasticsearch/painless/lang-painless/{version}-SNAPSHOT
endif::[]
ifeval::["{release-state}"!="unreleased"]
:elasticsearch-javadoc: https://artifacts.elastic.co/javadoc/org/elasticsearch/elasticsearch/{version}
:painless-javadoc: https://artifacts.elastic.co/javadoc/org/elasticsearch/painless/lang-painless/{version}
endif::[]
[DOCS] getting started tutorial
2014-04-18 13:51:59 -04:00
include::getting-started.asciidoc[]
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
include::setup.asciidoc[]
Core: Added the `index.query.parse.allow_unmapped_fields` setting to fail queries if they refer to unmapped fields. The percolator and filters in aliases by default enforce strict query parsing. Closes #7335
2014-07-18 16:50:07 -04:00
include::migration/index.asciidoc[]
[DOCS] Added breaking changes in 1.0
2014-01-15 11:50:24 -05:00
[DOCS] Reorganised common API conventions
2013-10-13 10:46:56 -04:00
include::api-conventions.asciidoc[]
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
include::docs.asciidoc[]
include::search.asciidoc[]
[DOCS] Restructure Aggs documentation
2015-05-01 16:04:55 -04:00
include::aggregations.asciidoc[]
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
include::indices.asciidoc[]
First pass at cat docs.
2013-11-14 20:14:39 -05:00
include::cat.asciidoc[]
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
include::cluster.asciidoc[]
include::query-dsl.asciidoc[]
include::mapping.asciidoc[]
include::analysis.asciidoc[]
include::modules.asciidoc[]
include::index-modules.asciidoc[]
Add ingest docs to the build
2016-02-11 17:16:56 -05:00
include::ingest.asciidoc[]
Add a how-to section to the docs. #18998 This moves the "Performance Considerations for Elasticsearch Indexing" blog post to the reference guide and adds similar recommendations for tuning disk usage and search speed.
2016-06-21 10:31:44 -04:00
include::how-to.asciidoc[]
[DOCS] Test framework documentation The java test framework using randomized testing is explained with a couple of examples.
2013-12-02 07:43:11 -05:00
include::testing.asciidoc[]
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
include::glossary.asciidoc[]
Use a comment block to comment out release notes
2016-09-08 12:30:37 -04:00
//////
include::release-notes.asciidoc[]
//////
Add release notes to docs index
2015-11-20 14:23:54 -05:00
Generate reference links for painless API (#22775) Adds "Appending B. Painless API Reference", a reference of all classes and methods available from Painless. Removes links to java packages because they contain methods that we don't expose and don't contain methods that we do expose (the ones in Augmentation). Instead this generates a list of every class and every exposed method using the same type information available to the interpreter/compiler/whatever-we-call-it. From there you can jump to the relevant docs. Right now you build all the asciidoc files by running ``` gradle generatePainlessApi ``` These files are expected to be committed because we build the docs without running `gradle`. Also changes the output of `Debug.explain` so that it is easy to search for the class in the generated reference documentation. You can also run it in an IDE safely if you pass the path to the directory in which to generate the docs as the first parameter. It'll blow away the entire directory an recreate it from scratch so be careful. And then you can build the docs by running something like: ``` ../docs/build_docs.pl --out ../built_docs/ --doc docs/reference/index.asciidoc --open ``` That is, if you have checked out https://github.com/elastic/docs in `../docs`. Wait a minute or two and your browser will pop open in with all of Elasticsearch's reference documentation. If you go to `http://localhost:8000/painless-api-reference.html` you can see this list. Or you can get there by following the links to `Modules` and `Scripting` and `Painless` and then clicking the link in the paragraphs below titled `Appendix B. Painless API Reference`. I like having these in asciidoc because we can deep link to them from the rest of the guide with constructs like `<<painless-api-reference-Object-hashCode-0>>` and `<<painless-api-reference->>` and we get link checking. Then the only brittle link maintenance bit is the link generation for javadoc. Which sucks. But I think it is important that we link to the methods directly so they are easy to find. Relates to #22720
2017-01-26 10:39:19 -05:00
include::painless-api-reference.asciidoc[]
Docs: Added stub entries for pages deleted from 1.x
2015-05-24 11:57:34 -04:00
include::redirects.asciidoc[]