[DOCS] Replace 'Elasticsearch' with 'OpenSearch' that used as software name #372

tlfeng · 2021-03-18T03:14:53Z

Issue #, if available:
#238

Description of changes:

The PR complete the work in PR #237

The PR requests merging the code into oss-docs branch.

Replace Elasticsearch that used as software name with OpenSearch (case sensitive)
Add TODO in the places that version number or file path need to be corrected.

// TODO(OpenSearch): Correct the version number
// TODO(OpenSearch): Correct the path

Exceptions - Didn't do the replacement in the following places:
(All the files are in docs directory)

Clients made for Elasticsearch
community-clients
perl
java-api (a part of "Elasticsearch" words remains)
Reference about features in old versions
reference/mapping/removal_of_types.asciidoc
Plugins made for Elasticsearch:
plugins/api
plugins/intrgrations
plugins/security
Other topics
Website links
License
Code snippets
README file - PR Updating README.md for docs/ #373

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

odfe-release-bot · 2021-03-18T03:16:49Z

❌ DCO Check Failed
Run ./dev-tools/signoff-check.sh remotes/origin/oss-docs 494a0a42913e869ba2252e8aa38c90bdfe1fd44c to check locally
Use git commit with -s to add 'Signed-of-by: {EMAIL}' on impacted commits

Signed-off-by: Tianli Feng <ftianli@amazon.com>

odfe-release-bot · 2021-03-18T03:48:46Z

✅ DCO Check Passed

Signed-off-by: Tianli Feng <ftianli@amazon.com>

odfe-release-bot · 2021-03-18T03:50:46Z

✅ DCO Check Passed

Signed-off-by: Tianli Feng <ftianli@amazon.com>

odfe-release-bot · 2021-03-18T03:52:49Z

✅ DCO Check Passed

setiah · 2021-03-18T03:55:07Z

docs/java-api/index.asciidoc

 [[java-api]]
 [preface]
 == Preface

-deprecated[7.0.0, The `TransportClient` is deprecated in favour of the {java-rest}/java-rest-high.html[Java High Level REST Client] and will be removed in Elasticsearch 8.0. The {java-rest}/java-rest-high-level-migration.html[migration guide] describes all the steps needed to migrate.]
+deprecated[7.0.0, The `TransportClient` is deprecated in favour of the {java-rest}/java-rest-high.html[Java High Level REST Client] and will be removed in OpenSearch 8.0. The {java-rest}/java-rest-high-level-migration.html[migration guide] describes all the steps needed to migrate.]


Can remove the last part here and will be removed in OpenSearch 8.0

Thank you. I will modify it.

setiah · 2021-03-18T03:59:00Z

docs/reference/index.asciidoc

@@ -1,5 +1,5 @@
 [[opensearch-reference]]
-= Elasticsearch Reference
+= OpenSearch Reference

 :es-test-dir:           {search-root}/docs/src/test


es-test-dir --> opensearch-test-dir

No problem, I will modify the asciidoc attributes in my next PR.

setiah · 2021-03-18T03:59:26Z

docs/reference/index.asciidoc

@@ -1,5 +1,5 @@
 [[opensearch-reference]]
-= Elasticsearch Reference
+= OpenSearch Reference

 :es-test-dir:           {search-root}/docs/src/test
 :plugins-examples-dir:  {search-root}/plugins/examples


es-repo-dir --> opensearch-repo-dir

Thank you, the asciidoc attributes will be resolved in my next PR.

setiah · 2021-03-18T04:01:00Z

docs/reference/modules/remote-clusters.asciidoc

@@ -287,7 +287,7 @@ separately.
  Per cluster boolean setting that enables you to configure compression for
  requests to a specific remote cluster. This setting impacts only requests
  sent to the remote cluster. If the inbound request is compressed,
-  Elasticsearch compresses the response. If unset, the global
+  OpenSearchcompresses the response. If unset, the global


Good catch! Thanks!

setiah · 2021-03-18T04:02:16Z

docs/reference/query-dsl/percolate-query.asciidoc

@@ -134,7 +135,7 @@ The following parameters are required when percolating a document:
         This is an optional parameter.
 `document`:: The source of the document being percolated.
 `documents`:: Like the `document` parameter, but accepts multiple documents via a json array.
-`document_type`:: The type / mapping of the document being percolated. This parameter is deprecated and will be removed in Elasticsearch 8.0.
+`document_type`:: The type / mapping of the document being percolated. This parameter is deprecated and will be removed in OpenSearch 8.0.


Remove this line. - This parameter is deprecated and will be removed in OpenSearch 8.0.

Our OpenSearch version will not be 8.0 and secondly, we are not sure yet if we will remove these deprecated parameters

Lol, "will not be 8.0" 😂 😏!

setiah · 2021-03-18T04:02:36Z

docs/reference/query-dsl/percolate-query.asciidoc

@@ -143,7 +144,7 @@ In that case the `document` parameter can be substituted with the following para

 [horizontal]
 `index`:: The index the document resides in. This is a required parameter.
-`type`:: The type of the document to fetch. This parameter is deprecated and will be removed in Elasticsearch 8.0.
+`type`:: The type of the document to fetch. This parameter is deprecated and will be removed in OpenSearch 8.0.


same as above

Removed. 👍

setiah · 2021-03-18T04:05:22Z

docs/reference/upgrade/synced-flush.asciidoc

 Note that synced flush is deprecated and will be removed in 8.0. A flush
-has the same effect as a synced flush on Elasticsearch 7.6 or later.
+has the same effect as a synced flush on OpenSearch 7.6 or later.


Remove - "will be removed in 8.0"

Thank you! I have removed these words.

setiah

Thanks Tianli. Added a few comments

Signed-off-by: Tianli Feng <ftianli@amazon.com>

odfe-release-bot · 2021-03-18T04:20:48Z

✅ DCO Check Passed

Signed-off-by: Tianli Feng <ftianli@amazon.com>

odfe-release-bot · 2021-03-18T04:26:50Z

✅ DCO Check Passed

Signed-off-by: Tianli Feng <ftianli@amazon.com>

odfe-release-bot · 2021-03-18T04:30:48Z

✅ DCO Check Passed

* Fixing issue when tracktotalhits is disabled Signed-off-by: Vacha Shah <vachshah@amazon.com> * Update Changelog Signed-off-by: Vacha Shah <vachshah@amazon.com> --------- Signed-off-by: Vacha Shah <vachshah@amazon.com> Co-authored-by: Daniel (dB.) Doubrovkine <dblock@amazon.com>

@apatrida

…h-project#412) * Adding x-amz-content-sha256 header for signed requests (opensearch-project#339) * Adding X-Amz-Content-Sha256 header for signed requests Signed-off-by: Vacha Shah <vachshah@amazon.com> * Adding CHANGELOG entry Signed-off-by: Vacha Shah <vachshah@amazon.com> * Adding documentation comment Signed-off-by: Vacha Shah <vachshah@amazon.com> * Adding tests Signed-off-by: Vacha Shah <vachshah@amazon.com> * Addressing comments Signed-off-by: Vacha Shah <vachshah@amazon.com> * Addressing comments Signed-off-by: Vacha Shah <vachshah@amazon.com> * Removing refresh policy for integ tests for Sigv4 Signed-off-by: Vacha Shah <vachshah@amazon.com> * Updating the developer guide Signed-off-by: Vacha Shah <vachshah@amazon.com> Signed-off-by: Vacha Shah <vachshah@amazon.com> Signed-off-by: MarinaRazumovsky <rzm.mrn@gmail.com> * Fix issue with completion suggester being parsed as term suggester. (opensearch-project#347) * Fix issue with completion suggester being parsed as term suggester. This commit fixes the issue where a completion suggester search request was being parsed as a term suggester and failing due to "Missing required property 'TermSuggestOption.score'" This solution was originally proposed by Github user @apatrida Signed-off-by: Dan Hart <git@danielhart.me> * Remove commented code Signed-off-by: Dan Hart <git@danielhart.me> * Fix format of changelog item Signed-off-by: Dan Hart <git@danielhart.me> Signed-off-by: Dan Hart <git@danielhart.me> Signed-off-by: MarinaRazumovsky <rzm.mrn@gmail.com> * Update USER_GUIDE to use exact AWS brand names (opensearch-project#352) Minor update to use exact brand names. "OpenSearch" is rather overloaded to I find it less confusing to be precise in the naming. Signed-off-by: Andrew Ross <andrross@amazon.com> Signed-off-by: Andrew Ross <andrross@amazon.com> Signed-off-by: MarinaRazumovsky <rzm.mrn@gmail.com> * Bumps Jackson from 2.14.1 to 2.14.2 (opensearch-project#357) Signed-off-by: Andriy Redko <andriy.redko@aiven.io> Signed-off-by: MarinaRazumovsky <rzm.mrn@gmail.com> * Bulk UpdateOperation misses upsert options (opensearch-project#353) * Bulk UpdateOperation misses upsert options Signed-off-by: Andriy Redko <andriy.redko@aiven.io> * Fix formatting Signed-off-by: Andriy Redko <andriy.redko@aiven.io> --------- Signed-off-by: Andriy Redko <andriy.redko@aiven.io> Signed-off-by: MarinaRazumovsky <rzm.mrn@gmail.com> * Upgrading compatibility to opensearch 2.5 (opensearch-project#367) * Upgrading compatibility to opensearch 2.5 Signed-off-by: amitai stern <123amitai@gmail.com> * latest 2.4 version Signed-off-by: amitai stern <123amitai@gmail.com> * keep existing compatibility matrix rows, this pr adds a new row for versions of opensearch after 2.3.0 Signed-off-by: amitai stern <123amitai@gmail.com> --------- Signed-off-by: amitai stern <123amitai@gmail.com> Signed-off-by: MarinaRazumovsky <rzm.mrn@gmail.com> * add option to set columns into cat indices request Signed-off-by: MarinaRazumovsky <rzm.mrn@gmail.com> * add changelog Signed-off-by: MarinaRazumovsky <rzm.mrn@gmail.com> * changes in CatRequestBase, IndicesRequest, NodesRequest, RecoveryRequest and add tests Signed-off-by: MarinaRazumovsky <rzm.mrn@gmail.com> * Feature/range aggregation fix 369 (opensearch-project#370) * test: create integration tests for date_range and range aggregation (opensearch-project#369) Signed-off-by: Dominik Szczepanczyk <szczepanczyk.dominik@gmail.com> * fix: add a missing key propery to the RangeBucket (opensearch-project#369) Signed-off-by: Dominik Szczepanczyk <szczepanczyk.dominik@gmail.com> * docs: add CHANGELOG entry (opensearch-project#369) Signed-off-by: Dominik Szczepanczyk <szczepanczyk.dominik@gmail.com> --------- Signed-off-by: Dominik Szczepanczyk <szczepanczyk.dominik@gmail.com> Signed-off-by: MarinaRazumovsky <rzm.mrn@gmail.com> * Fixing integration tests (opensearch-project#375) * Fixing integration tests Signed-off-by: Vacha Shah <vachshah@amazon.com> * Updating the test with a non-exact check Signed-off-by: Vacha Shah <vachshah@amazon.com> --------- Signed-off-by: Vacha Shah <vachshah@amazon.com> Signed-off-by: MarinaRazumovsky <rzm.mrn@gmail.com> * Adding bulk request example in user guide (opensearch-project#373) Signed-off-by: Vacha Shah <vachshah@amazon.com> Signed-off-by: MarinaRazumovsky <rzm.mrn@gmail.com> * Fixing issue when tracktotalhits is disabled (opensearch-project#372) * Fixing issue when tracktotalhits is disabled Signed-off-by: Vacha Shah <vachshah@amazon.com> * Update Changelog Signed-off-by: Vacha Shah <vachshah@amazon.com> --------- Signed-off-by: Vacha Shah <vachshah@amazon.com> Co-authored-by: Daniel (dB.) Doubrovkine <dblock@amazon.com> Signed-off-by: MarinaRazumovsky <rzm.mrn@gmail.com> * changes changelog Signed-off-by: MarinaRazumovsky <rzm.mrn@gmail.com> * Bump io.github.classgraph:classgraph from 4.8.154 to 4.8.156 (opensearch-project#390) * Bump io.github.classgraph:classgraph from 4.8.154 to 4.8.156 Bumps [io.github.classgraph:classgraph](https://github.com/classgraph/classgraph) from 4.8.154 to 4.8.156. - [Release notes](https://github.com/classgraph/classgraph/releases) - [Commits](classgraph/classgraph@classgraph-4.8.154...classgraph-4.8.156) --- updated-dependencies: - dependency-name: io.github.classgraph:classgraph dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> * Update changelog Signed-off-by: dependabot[bot] <support@github.com> --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <dependabot[bot]@users.noreply.github.com> Signed-off-by: MarinaRazumovsky <rzm.mrn@gmail.com> * Add 2PR approval to release workflow (opensearch-project#383) Signed-off-by: Sayali Gaikawad <gaiksaya@amazon.com> Signed-off-by: MarinaRazumovsky <rzm.mrn@gmail.com> * Adding an example to use raw JSON class instead of target classes (opensearch-project#385) Signed-off-by: Vacha Shah <vachshah@amazon.com> Signed-off-by: MarinaRazumovsky <rzm.mrn@gmail.com> * Update Gradle to 8.0.2 (opensearch-project#392) Signed-off-by: Andriy Redko <andriy.redko@aiven.io> Signed-off-by: MarinaRazumovsky <rzm.mrn@gmail.com> * Add "mappings" field to IndexSettings object (opensearch-project#382) Signed-off-by: Ilya Lukyanovich <l000kian@gmail.com> Signed-off-by: MarinaRazumovsky <rzm.mrn@gmail.com> * Created untriaged issue workflow. (opensearch-project#364) Signed-off-by: dblock <dblock@amazon.com> Signed-off-by: MarinaRazumovsky <rzm.mrn@gmail.com> * Bump io.github.classgraph:classgraph from 4.8.156 to 4.8.157 in /java-client (opensearch-project#403) * Bump io.github.classgraph:classgraph in /java-client Bumps [io.github.classgraph:classgraph](https://github.com/classgraph/classgraph) from 4.8.156 to 4.8.157. - [Release notes](https://github.com/classgraph/classgraph/releases) - [Commits](classgraph/classgraph@classgraph-4.8.156...classgraph-4.8.157) --- updated-dependencies: - dependency-name: io.github.classgraph:classgraph dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> * Update changelog Signed-off-by: dependabot[bot] <support@github.com> --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <dependabot[bot]@users.noreply.github.com> Signed-off-by: MarinaRazumovsky <rzm.mrn@gmail.com> * Add buffered lookahead for Jackson (opensearch-project#338) Signed-off-by: luneo7 <luneo7@gmail.com> Signed-off-by: MarinaRazumovsky <rzm.mrn@gmail.com> * Mask env values for snapshots (opensearch-project#411) Signed-off-by: Sayali Gaikawad <gaiksaya@amazon.com> Signed-off-by: MarinaRazumovsky <rzm.mrn@gmail.com> * option to set headers and sort into cat requests Signed-off-by: MarinaRazumovsky <rzm.mrn@gmail.com> * fix test Signed-off-by: MarinaRazumovsky <rzm.mrn@gmail.com> * fix changelog Signed-off-by: MarinaRazumovsky <rzm.mrn@gmail.com> * add cat examples into USER_GUID Signed-off-by: MarinaRazumovsky <rzm.mrn@gmail.com> --------- Signed-off-by: Vacha Shah <vachshah@amazon.com> Signed-off-by: MarinaRazumovsky <rzm.mrn@gmail.com> Signed-off-by: Dan Hart <git@danielhart.me> Signed-off-by: Andrew Ross <andrross@amazon.com> Signed-off-by: Andriy Redko <andriy.redko@aiven.io> Signed-off-by: amitai stern <123amitai@gmail.com> Signed-off-by: Dominik Szczepanczyk <szczepanczyk.dominik@gmail.com> Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: Sayali Gaikawad <gaiksaya@amazon.com> Signed-off-by: Ilya Lukyanovich <l000kian@gmail.com> Signed-off-by: dblock <dblock@amazon.com> Signed-off-by: luneo7 <luneo7@gmail.com> Co-authored-by: Vacha Shah <vachshah@amazon.com> Co-authored-by: Danny Hart <git@danielhart.me> Co-authored-by: Andrew Ross <andrross@amazon.com> Co-authored-by: Andriy Redko <andriy.redko@aiven.io> Co-authored-by: amitai stern <123amitai@gmail.com> Co-authored-by: szczepanczykd <48957041+szczepanczykd@users.noreply.github.com> Co-authored-by: Daniel (dB.) Doubrovkine <dblock@amazon.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <dependabot[bot]@users.noreply.github.com> Co-authored-by: Sayali Gaikawad <61760125+gaiksaya@users.noreply.github.com> Co-authored-by: Ilya Lukyanovich <ilya.lukyanovich@dataart.com> Co-authored-by: Lucas Rogerio Caetano Ferreira <luneo7@users.noreply.github.com>

tlfeng added documentation Improvements or additions to documentation >FORK Related to the fork process Rename Renaming to OpenSearch labels Mar 18, 2021

tlfeng requested review from setiah and removed request for setiah March 18, 2021 03:14

tlfeng mentioned this pull request Mar 18, 2021

[DOCS] Replace most of the 'Elasticsearch' with '{opensearch}' #237

Closed

Tianli Feng added 8 commits March 17, 2021 20:35

Replace Elasticsearch to {opensearch} - part 1

c8e7fb2

Signed-off-by: Tianli Feng <ftianli@amazon.com>

Replace Elasticsearch to {opensearch} - part 2

e2ae606

Signed-off-by: Tianli Feng <ftianli@amazon.com>

Replace Elasticsearch to {opensearch} - part 3

0073118

Signed-off-by: Tianli Feng <ftianli@amazon.com>

Replace Elasticsearch to {opensearch} - part 4

8494a92

Signed-off-by: Tianli Feng <ftianli@amazon.com>

Change all Opensearch to OpenSearch

59d78f8

Signed-off-by: Tianli Feng <ftianli@amazon.com>

Replace Elasticsearch with {opensearch} in java-api

f4b7f4d

Signed-off-by: Tianli Feng <ftianli@amazon.com>

Replace all {opensearch} with OpenSearch

36b7308

Signed-off-by: Tianli Feng <ftianli@amazon.com>

Restore docs/README.asciidoc

22e507a

Signed-off-by: Tianli Feng <ftianli@amazon.com>

tlfeng force-pushed the docs-rename branch from 494a0a4 to 22e507a Compare March 18, 2021 03:46

Tianli Feng added 2 commits March 17, 2021 20:49

Add TODO for version number correctness

6c78b64

Signed-off-by: Tianli Feng <ftianli@amazon.com>

Remove a additional blank line

a89430e

Signed-off-by: Tianli Feng <ftianli@amazon.com>

Modify a TODO message

85a2c6f

Signed-off-by: Tianli Feng <ftianli@amazon.com>

tlfeng requested a review from setiah March 18, 2021 03:51

tlfeng marked this pull request as ready for review March 18, 2021 03:51

setiah reviewed Mar 18, 2021

View reviewed changes

setiah suggested changes Mar 18, 2021

View reviewed changes

Tianli Feng added 2 commits March 17, 2021 21:18

Remove 'and will be removed in OpenSearch 8.0' for java-api

c33fdfa

Signed-off-by: Tianli Feng <ftianli@amazon.com>

Add a space that removed accidentally

35783f1

Signed-off-by: Tianli Feng <ftianli@amazon.com>

Remove 'will be removed in OpenSearch 8.0' in several places

7d96500

Signed-off-by: Tianli Feng <ftianli@amazon.com>

Modify the TODO messages

6710513

Signed-off-by: Tianli Feng <ftianli@amazon.com>

setiah approved these changes Mar 18, 2021

View reviewed changes

setiah merged commit f026289 into opensearch-project:oss-docs Mar 18, 2021

tlfeng deleted the docs-rename branch March 18, 2021 21:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DOCS] Replace 'Elasticsearch' with 'OpenSearch' that used as software name #372

[DOCS] Replace 'Elasticsearch' with 'OpenSearch' that used as software name #372

tlfeng commented Mar 18, 2021 •

edited

Loading

odfe-release-bot commented Mar 18, 2021

odfe-release-bot commented Mar 18, 2021

odfe-release-bot commented Mar 18, 2021

odfe-release-bot commented Mar 18, 2021

setiah Mar 18, 2021

tlfeng Mar 18, 2021

tlfeng Mar 18, 2021

setiah Mar 18, 2021

tlfeng Mar 18, 2021

setiah Mar 18, 2021

tlfeng Mar 18, 2021

setiah Mar 18, 2021

tlfeng Mar 18, 2021

setiah Mar 18, 2021

tlfeng Mar 18, 2021

setiah Mar 18, 2021

tlfeng Mar 18, 2021

setiah Mar 18, 2021

tlfeng Mar 18, 2021

setiah left a comment

odfe-release-bot commented Mar 18, 2021

odfe-release-bot commented Mar 18, 2021

odfe-release-bot commented Mar 18, 2021

[DOCS] Replace 'Elasticsearch' with 'OpenSearch' that used as software name #372

[DOCS] Replace 'Elasticsearch' with 'OpenSearch' that used as software name #372

Conversation

tlfeng commented Mar 18, 2021 • edited Loading

odfe-release-bot commented Mar 18, 2021

odfe-release-bot commented Mar 18, 2021

odfe-release-bot commented Mar 18, 2021

odfe-release-bot commented Mar 18, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

setiah left a comment

Choose a reason for hiding this comment

odfe-release-bot commented Mar 18, 2021

odfe-release-bot commented Mar 18, 2021

odfe-release-bot commented Mar 18, 2021

tlfeng commented Mar 18, 2021 •

edited

Loading