Skip to content

Commit

Permalink
[DOCS] Swap [float] for [discrete] (#60136)
Browse files Browse the repository at this point in the history
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
  • Loading branch information
jrodewig authored Jul 23, 2020
1 parent 80b2a7b commit 71c60d6
Show file tree
Hide file tree
Showing 282 changed files with 1,377 additions and 1,377 deletions.
2 changes: 1 addition & 1 deletion docs/java-api/admin/indices/create-index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Using an <<java-admin-indices,`IndicesAdminClient`>>, you can create an index wi
client.admin().indices().prepareCreate("twitter").get();
--------------------------------------------------

[float]
[discrete]
[[java-admin-indices-create-index-settings]]
===== Index Settings

Expand Down
6 changes: 3 additions & 3 deletions docs/java-api/docs/update-by-query.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ specifying a `pipeline` like this:
include-tagged::{client-reindex-tests}/ReindexDocumentationIT.java[update-by-query-pipeline]
--------------------------------------------------

[float]
[discrete]
[[java-docs-update-by-query-task-api]]
=== Works with the Task API

Expand All @@ -130,7 +130,7 @@ With the `TaskId` shown above you can look up the task directly:
include-tagged::{client-reindex-tests}/ReindexDocumentationIT.java[update-by-query-get-task]
--------------------------------------------------

[float]
[discrete]
[[java-docs-update-by-query-cancel-task-api]]
=== Works with the Cancel Task API

Expand All @@ -146,7 +146,7 @@ Use the `list tasks` API to find the value of `taskId`.
Cancelling a request is typically a very fast process but can take up to a few seconds.
The task status API continues to list the task until the cancellation is complete.

[float]
[discrete]
[[java-docs-update-by-query-rethrottle]]
=== Rethrottling

Expand Down
10 changes: 5 additions & 5 deletions docs/painless/painless-guide/painless-walkthrough.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ PUT hockey/_bulk?refresh
----------------------------------------------------------------
// TESTSETUP

[float]
[discrete]
==== Accessing Doc Values from Painless

Document values can be accessed from a `Map` named `doc`.
Expand Down Expand Up @@ -111,7 +111,7 @@ GET hockey/_search
----------------------------------------------------------------


[float]
[discrete]
==== Missing values

`doc['field'].value` throws an exception if
Expand All @@ -121,7 +121,7 @@ To check if a document is missing a value, you can call
`doc['field'].size() == 0`.


[float]
[discrete]
==== Updating Fields with Painless

You can also easily update fields. You access the original source for a field as `ctx._source.<field-name>`.
Expand Down Expand Up @@ -177,7 +177,7 @@ POST hockey/_update/1
}
----------------------------------------------------------------

[float]
[discrete]
[[modules-scripting-painless-dates]]
==== Dates

Expand All @@ -202,7 +202,7 @@ GET hockey/_search
}
----------------------------------------------------------------

[float]
[discrete]
[[modules-scripting-painless-regex]]
==== Regular expressions

Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/alerting.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

Alerting plugins allow Elasticsearch to monitor indices and to trigger alerts when thresholds are breached.

[float]
[discrete]
=== Core alerting plugins

The core alerting plugins are:
Expand Down
4 changes: 2 additions & 2 deletions docs/plugins/analysis-phonetic.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ is often beneficial to use separate fields for analysis with and without phoneti
That way searches can be run against both fields with differing boosts and trade-offs (e.g.
only run a fuzzy `match` query on the original text field, but not on the phonetic version).

[float]
[discrete]
===== Double metaphone settings

If the `double_metaphone` encoder is used, then this additional setting is
Expand All @@ -83,7 +83,7 @@ supported:

The maximum length of the emitted metaphone token. Defaults to `4`.

[float]
[discrete]
===== Beider Morse settings

If the `beider_morse` encoder is used, then these additional settings are
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/analysis-smartcn.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ include::install_remove.asciidoc[]


[[analysis-smartcn-tokenizer]]
[float]
[discrete]
==== `smartcn` tokenizer and token filter

The plugin provides the `smartcn` analyzer, `smartcn_tokenizer` tokenizer, and
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/analysis-stempel.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ http://www.egothor.org/[Egothor project].
include::install_remove.asciidoc[]

[[analysis-stempel-tokenizer]]
[float]
[discrete]
==== `stempel` tokenizer and token filters

The plugin provides the `polish` analyzer and the `polish_stem` and `polish_stop` token filters,
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/analysis-ukrainian.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ It provides stemming for Ukrainian using the http://github.com/morfologik/morfol
include::install_remove.asciidoc[]

[[analysis-ukrainian-analyzer]]
[float]
[discrete]
==== `ukrainian` analyzer

The plugin provides the `ukrainian` analyzer.
4 changes: 2 additions & 2 deletions docs/plugins/analysis.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Analysis plugins extend Elasticsearch by adding new analyzers, tokenizers,
token filters, or character filters to Elasticsearch.

[float]
[discrete]
==== Core analysis plugins

The core analysis plugins are:
Expand Down Expand Up @@ -44,7 +44,7 @@ Provides high quality stemming for Polish.

Provides stemming for Ukrainian.

[float]
[discrete]
==== Community contributed analysis plugins

A number of analysis plugins have been contributed by our community:
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/api.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

API extension plugins add new functionality to Elasticsearch by adding new APIs or features, usually to do with search or mapping.

[float]
[discrete]
=== Community contributed API extension plugins

A number of plugins have been contributed by our community:
Expand Down
8 changes: 4 additions & 4 deletions docs/plugins/authors.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ These examples provide the bare bones needed to get started. For more
information about how to write a plugin, we recommend looking at the plugins
listed in this documentation for inspiration.

[float]
[discrete]
=== Plugin descriptor file

All plugins must contain a file called `plugin-descriptor.properties`.
Expand All @@ -32,7 +32,7 @@ include::{plugin-properties-files}/plugin-descriptor.properties[]
Either fill in this template yourself or, if you are using Elasticsearch's Gradle build system, you
can fill in the necessary values in the `build.gradle` file for your plugin.

[float]
[discrete]
==== Mandatory elements for plugins


Expand Down Expand Up @@ -70,7 +70,7 @@ in the presence of plugins with the incorrect `elasticsearch.version`.
==============================================


[float]
[discrete]
=== Testing your plugin

When testing a Java plugin, it will only be auto-loaded if it is in the
Expand All @@ -81,7 +81,7 @@ You may also load your plugin within the test framework for integration tests.
Read more in {ref}/integration-tests.html#changing-node-configuration[Changing Node Configuration].


[float]
[discrete]
[[plugin-authors-jsm]]
=== Java Security permissions

Expand Down
4 changes: 2 additions & 2 deletions docs/plugins/discovery.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Discovery plugins extend Elasticsearch by adding new seed hosts providers that
can be used to extend the {ref}/modules-discovery.html[cluster formation
module].

[float]
[discrete]
==== Core discovery plugins

The core discovery plugins are:
Expand All @@ -25,7 +25,7 @@ addresses of seed hosts.
The Google Compute Engine discovery plugin uses the GCE API to identify the
addresses of seed hosts.

[float]
[discrete]
==== Community contributed discovery plugins

The following discovery plugins have been contributed by our community:
Expand Down
4 changes: 2 additions & 2 deletions docs/plugins/ingest.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

The ingest plugins extend Elasticsearch by providing additional ingest node capabilities.

[float]
[discrete]
=== Core Ingest Plugins

The core ingest plugins are:
Expand All @@ -29,7 +29,7 @@ A processor that extracts details from the User-Agent header value. The
distributed by default with Elasticsearch. See
{ref}/user-agent-processor.html[User Agent processor] for more details.

[float]
[discrete]
=== Community contributed ingest plugins

The following plugin has been contributed by our community:
Expand Down
4 changes: 2 additions & 2 deletions docs/plugins/install_remove.asciidoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[float]
[discrete]
[id="{plugin_name}-install"]
==== Installation

Expand All @@ -25,7 +25,7 @@ This plugin can be downloaded for <<plugin-management-custom-url,offline install

endif::[]

[float]
[discrete]
[id="{plugin_name}-remove"]
==== Removal

Expand Down
34 changes: 17 additions & 17 deletions docs/plugins/integrations.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@

Integrations are not plugins, but are external tools or modules that make it easier to work with Elasticsearch.

[float]
[discrete]
[[cms-integrations]]
=== CMS integrations

[float]
[discrete]
==== Supported by the community:

* http://drupal.org/project/search_api_elasticsearch[Drupal]:
Expand All @@ -31,14 +31,14 @@ Integrations are not plugins, but are external tools or modules that make it eas
* http://extensions.xwiki.org/xwiki/bin/view/Extension/Elastic+Search+Macro/[XWiki Next Generation Wiki]:
XWiki has an Elasticsearch and Kibana macro allowing to run Elasticsearch queries and display the results in XWiki pages using XWiki's scripting language as well as include Kibana Widgets in XWiki pages

[float]
[discrete]
[[data-integrations]]
=== Data import/export and validation

NOTE: Rivers were used to import data from external systems into Elasticsearch prior to the 2.0 release. Elasticsearch
releases 2.0 and later do not support rivers.

[float]
[discrete]
==== Supported by Elasticsearch:

* {logstash-ref}/plugins-outputs-elasticsearch.html[Logstash output to Elasticsearch]:
Expand All @@ -50,7 +50,7 @@ releases 2.0 and later do not support rivers.
* {logstash-ref}/plugins-codecs-es_bulk.html[Elasticsearch bulk codec]
The Logstash `es_bulk` plugin decodes the Elasticsearch bulk format into individual events.

[float]
[discrete]
==== Supported by the community:

* https://github.com/jprante/elasticsearch-jdbc[JDBC importer]:
Expand All @@ -75,11 +75,11 @@ releases 2.0 and later do not support rivers.
* https://github.com/senacor/elasticsearch-evolution[Elasticsearch Evolution]:
A library to migrate elasticsearch mappings.

[float]
[discrete]
[[deployment]]
=== Deployment

[float]
[discrete]
==== Supported by Elasticsearch:

* https://github.com/elastic/ansible-elasticsearch[Ansible playbook for Elasticsearch]:
Expand All @@ -88,17 +88,17 @@ releases 2.0 and later do not support rivers.
* https://github.com/elastic/puppet-elasticsearch[Puppet]:
Elasticsearch puppet module.

[float]
[discrete]
==== Supported by the community:

* https://github.com/elastic/cookbook-elasticsearch[Chef]:
Chef cookbook for Elasticsearch

[float]
[discrete]
[[framework-integrations]]
=== Framework integrations

[float]
[discrete]
==== Supported by the community:

* http://www.searchtechnologies.com/aspire-for-elasticsearch[Aspire for Elasticsearch]:
Expand Down Expand Up @@ -157,29 +157,29 @@ releases 2.0 and later do not support rivers.
* https://micrometer.io[Micrometer]:
Vendor-neutral application metrics facade. Think SLF4j, but for metrics.

[float]
[discrete]
[[hadoop-integrations]]
=== Hadoop integrations

[float]
[discrete]
==== Supported by Elasticsearch:

* link:/guide/en/elasticsearch/hadoop/current/[es-hadoop]: Elasticsearch real-time
search and analytics natively integrated with Hadoop. Supports Map/Reduce,
Cascading, Apache Hive, Apache Pig, Apache Spark and Apache Storm.

[float]
[discrete]
==== Supported by the community:

* https://github.com/criteo/garmadon[Garmadon]:
Garmadon is a solution for Hadoop Cluster realtime introspection.


[float]
[discrete]
[[monitoring-integrations]]
=== Health and Performance Monitoring

[float]
[discrete]
==== Supported by the community:

* https://github.com/radu-gheorghe/check-es[check-es]:
Expand All @@ -193,10 +193,10 @@ releases 2.0 and later do not support rivers.
and receive events information.

[[other-integrations]]
[float]
[discrete]
=== Other integrations

[float]
[discrete]
==== Supported by the community:

* https://www.wireshark.org/[Wireshark]:
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/management.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

Management plugins offer UIs for managing and interacting with Elasticsearch.

[float]
[discrete]
=== Core management plugins

The core management plugins are:
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/mapper.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

Mapper plugins allow new field data types to be added to Elasticsearch.

[float]
[discrete]
=== Core mapper plugins

The core mapper plugins are:
Expand Down
Loading

0 comments on commit 71c60d6

Please sign in to comment.