Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Replace 'elasticsearch' that used as plain text in the code snippets #367

Closed

Conversation

tlfeng
Copy link
Collaborator

@tlfeng tlfeng commented Mar 18, 2021

Issue #, if available:
#238

Description of changes:

The PR continues the work in PR #249

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

  • Replace elasticsearch, Elasticsearch that used as plain text in code snippets
  • Replace some elasticsearch in docs/build.gralde that used to generate data for the code snippet tests
  • Add TODOs for some example where elasticsearch keywords can't be replaced smoothly
// TODO(OpenSearch): Replace the setup code of 'stackoverflow' and 'news' with better ones
// TODO(OpenSearch): Replace with a better example
// TODO(OpenSearch): Replace with a new example
// TODO(OpenSearch): Replace 'Elasticsearch' and 'elasticsearch' in 'description' or test will fail

Note: References in docs/java-api are not renamed in the PR.

Testing: ./gradlew :docs:check passed.

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

@tlfeng tlfeng added documentation Improvements or additions to documentation >FORK Related to the fork process Rename Renaming to OpenSearch labels Mar 18, 2021
@odfe-release-bot
Copy link

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

@odfe-release-bot
Copy link

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

@tlfeng tlfeng force-pushed the docs-name-example-text branch from c73ac65 to 7f88af6 Compare March 18, 2021 01:08
@odfe-release-bot
Copy link

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

@tlfeng tlfeng force-pushed the docs-name-example-text branch from 7f88af6 to bb4eefc Compare March 18, 2021 01:26
@odfe-release-bot
Copy link

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

@tlfeng tlfeng force-pushed the docs-name-example-text branch from bb4eefc to 01e4fc1 Compare March 18, 2021 01:32
@odfe-release-bot
Copy link

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

@tlfeng tlfeng force-pushed the docs-name-example-text branch from 01e4fc1 to 2983f5f Compare March 18, 2021 01:39
@odfe-release-bot
Copy link

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

@tlfeng tlfeng force-pushed the docs-name-example-text branch 2 times, most recently from fe937cc to d757765 Compare March 18, 2021 01:44
@odfe-release-bot
Copy link

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

@odfe-release-bot
Copy link

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

@@ -24,7 +25,7 @@ POST /stackoverflow/_search?size=0
{
"query": {
"query_string": {
"query": "tags:kibana OR tags:javascript"
"query": "tags:opensearch\\-dashboards OR tags:javascript"
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@odfe-release-bot
Copy link

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

@odfe-release-bot
Copy link

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

@odfe-release-bot
Copy link

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

@odfe-release-bot
Copy link

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

@tlfeng tlfeng force-pushed the docs-name-example-text branch from 6ac65b4 to cf0e83b Compare March 18, 2021 07:04
@odfe-release-bot
Copy link

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

@tlfeng tlfeng force-pushed the docs-name-example-text branch from cf0e83b to 70e1eaa Compare March 18, 2021 07:06
@odfe-release-bot
Copy link

✅   DCO Check Passed

@tlfeng tlfeng marked this pull request as ready for review March 18, 2021 07:15
@odfe-release-bot
Copy link

✅   DCO Check Passed

@tlfeng tlfeng requested a review from setiah March 18, 2021 17:05
Signed-off-by: Tianli Feng <[email protected]>
@odfe-release-bot
Copy link

✅   DCO Check Passed

Signed-off-by: Tianli Feng <[email protected]>
@odfe-release-bot
Copy link

✅   DCO Check Passed

Signed-off-by: Tianli Feng <[email protected]>
@odfe-release-bot
Copy link

✅   DCO Check Passed

@odfe-release-bot
Copy link

✅   DCO Check Passed

@odfe-release-bot
Copy link

✅   DCO Check Passed

@odfe-release-bot
Copy link

✅   DCO Check Passed

@odfe-release-bot
Copy link

✅   DCO Check Passed

@@ -335,20 +336,20 @@ buildRestTests.setups['stackoverflow'] = '''
refresh: true
body: |'''

// Make Kibana strongly connected to elasticsearch and logstash
// Make Kibana rarer (and therefore higher-ranking) than JavaScript
// Make OpenSearch Dashboards strongly connected to opensearch and opensource
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

small change

Suggested change
// Make OpenSearch Dashboards strongly connected to opensearch and opensource
// Make OpenSearch Dashboards strongly connected to opensearch

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! But the opensource is a replacement of logstash that used in the example, and I know that there are several casual changes to replace the original example, we can discuss further. 😁

@setiah setiah closed this Mar 20, 2021
ritty27 pushed a commit to ritty27/OpenSearch that referenced this pull request May 12, 2024
* Upgrading compatibility to opensearch 2.5

Signed-off-by: amitai stern <[email protected]>

* latest 2.4 version

Signed-off-by: amitai stern <[email protected]>

* keep existing compatibility matrix rows, this pr adds a new row for versions of opensearch after 2.3.0

Signed-off-by: amitai stern <[email protected]>

---------

Signed-off-by: amitai stern <[email protected]>
ritty27 pushed a commit to ritty27/OpenSearch that referenced this pull request May 12, 2024
…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 <[email protected]>

* Adding CHANGELOG entry

Signed-off-by: Vacha Shah <[email protected]>

* Adding documentation comment

Signed-off-by: Vacha Shah <[email protected]>

* Adding tests

Signed-off-by: Vacha Shah <[email protected]>

* Addressing comments

Signed-off-by: Vacha Shah <[email protected]>

* Addressing comments

Signed-off-by: Vacha Shah <[email protected]>

* Removing refresh policy for integ tests for Sigv4

Signed-off-by: Vacha Shah <[email protected]>

* Updating the developer guide

Signed-off-by: Vacha Shah <[email protected]>

Signed-off-by: Vacha Shah <[email protected]>
Signed-off-by: MarinaRazumovsky <[email protected]>

* 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 <[email protected]>

* Remove commented code

Signed-off-by: Dan Hart <[email protected]>

* Fix format of changelog item

Signed-off-by: Dan Hart <[email protected]>

Signed-off-by: Dan Hart <[email protected]>
Signed-off-by: MarinaRazumovsky <[email protected]>

* 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 <[email protected]>

Signed-off-by: Andrew Ross <[email protected]>
Signed-off-by: MarinaRazumovsky <[email protected]>

* Bumps Jackson from 2.14.1 to 2.14.2 (opensearch-project#357)

Signed-off-by: Andriy Redko <[email protected]>
Signed-off-by: MarinaRazumovsky <[email protected]>

* Bulk UpdateOperation misses upsert options (opensearch-project#353)

* Bulk UpdateOperation misses upsert options

Signed-off-by: Andriy Redko <[email protected]>

* Fix formatting

Signed-off-by: Andriy Redko <[email protected]>

---------

Signed-off-by: Andriy Redko <[email protected]>
Signed-off-by: MarinaRazumovsky <[email protected]>

* Upgrading compatibility to opensearch 2.5 (opensearch-project#367)

* Upgrading compatibility to opensearch 2.5

Signed-off-by: amitai stern <[email protected]>

* latest 2.4 version

Signed-off-by: amitai stern <[email protected]>

* keep existing compatibility matrix rows, this pr adds a new row for versions of opensearch after 2.3.0

Signed-off-by: amitai stern <[email protected]>

---------

Signed-off-by: amitai stern <[email protected]>
Signed-off-by: MarinaRazumovsky <[email protected]>

* add option to set columns into cat indices request

Signed-off-by: MarinaRazumovsky <[email protected]>

* add changelog

Signed-off-by: MarinaRazumovsky <[email protected]>

* changes in CatRequestBase, IndicesRequest, NodesRequest, RecoveryRequest and add tests

Signed-off-by: MarinaRazumovsky <[email protected]>

* 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 <[email protected]>

* fix: add a missing key propery to the RangeBucket (opensearch-project#369)

Signed-off-by: Dominik Szczepanczyk <[email protected]>

* docs: add CHANGELOG entry (opensearch-project#369)

Signed-off-by: Dominik Szczepanczyk <[email protected]>

---------

Signed-off-by: Dominik Szczepanczyk <[email protected]>
Signed-off-by: MarinaRazumovsky <[email protected]>

* Fixing integration tests (opensearch-project#375)

* Fixing integration tests

Signed-off-by: Vacha Shah <[email protected]>

* Updating the test with a non-exact check

Signed-off-by: Vacha Shah <[email protected]>

---------

Signed-off-by: Vacha Shah <[email protected]>
Signed-off-by: MarinaRazumovsky <[email protected]>

* Adding bulk request example in user guide (opensearch-project#373)

Signed-off-by: Vacha Shah <[email protected]>
Signed-off-by: MarinaRazumovsky <[email protected]>

* Fixing issue when tracktotalhits is disabled (opensearch-project#372)

* Fixing issue when tracktotalhits is disabled

Signed-off-by: Vacha Shah <[email protected]>

* Update Changelog

Signed-off-by: Vacha Shah <[email protected]>

---------

Signed-off-by: Vacha Shah <[email protected]>
Co-authored-by: Daniel (dB.) Doubrovkine <[email protected]>
Signed-off-by: MarinaRazumovsky <[email protected]>

* changes changelog

Signed-off-by: MarinaRazumovsky <[email protected]>

* 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] <[email protected]>

* Update changelog

Signed-off-by: dependabot[bot] <[email protected]>

---------

Signed-off-by: dependabot[bot] <[email protected]>
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 <[email protected]>

* Add 2PR approval to release workflow (opensearch-project#383)

Signed-off-by: Sayali Gaikawad <[email protected]>
Signed-off-by: MarinaRazumovsky <[email protected]>

* Adding an example to use raw JSON class instead of target classes (opensearch-project#385)

Signed-off-by: Vacha Shah <[email protected]>
Signed-off-by: MarinaRazumovsky <[email protected]>

* Update Gradle to 8.0.2 (opensearch-project#392)

Signed-off-by: Andriy Redko <[email protected]>
Signed-off-by: MarinaRazumovsky <[email protected]>

* Add "mappings" field to IndexSettings object (opensearch-project#382)

Signed-off-by: Ilya Lukyanovich <[email protected]>
Signed-off-by: MarinaRazumovsky <[email protected]>

* Created untriaged issue workflow. (opensearch-project#364)

Signed-off-by: dblock <[email protected]>
Signed-off-by: MarinaRazumovsky <[email protected]>

* 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] <[email protected]>

* Update changelog

Signed-off-by: dependabot[bot] <[email protected]>

---------

Signed-off-by: dependabot[bot] <[email protected]>
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 <[email protected]>

* Add buffered lookahead for Jackson (opensearch-project#338)

Signed-off-by: luneo7 <[email protected]>
Signed-off-by: MarinaRazumovsky <[email protected]>

* Mask env values for snapshots (opensearch-project#411)

Signed-off-by: Sayali Gaikawad <[email protected]>
Signed-off-by: MarinaRazumovsky <[email protected]>

* option to set headers and sort into cat requests

Signed-off-by: MarinaRazumovsky <[email protected]>

* fix test

Signed-off-by: MarinaRazumovsky <[email protected]>

* fix changelog

Signed-off-by: MarinaRazumovsky <[email protected]>

* add cat examples into USER_GUID

Signed-off-by: MarinaRazumovsky <[email protected]>

---------

Signed-off-by: Vacha Shah <[email protected]>
Signed-off-by: MarinaRazumovsky <[email protected]>
Signed-off-by: Dan Hart <[email protected]>
Signed-off-by: Andrew Ross <[email protected]>
Signed-off-by: Andriy Redko <[email protected]>
Signed-off-by: amitai stern <[email protected]>
Signed-off-by: Dominik Szczepanczyk <[email protected]>
Signed-off-by: dependabot[bot] <[email protected]>
Signed-off-by: Sayali Gaikawad <[email protected]>
Signed-off-by: Ilya Lukyanovich <[email protected]>
Signed-off-by: dblock <[email protected]>
Signed-off-by: luneo7 <[email protected]>
Co-authored-by: Vacha Shah <[email protected]>
Co-authored-by: Danny Hart <[email protected]>
Co-authored-by: Andrew Ross <[email protected]>
Co-authored-by: Andriy Redko <[email protected]>
Co-authored-by: amitai stern <[email protected]>
Co-authored-by: szczepanczykd <[email protected]>
Co-authored-by: Daniel (dB.) Doubrovkine <[email protected]>
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 <[email protected]>
Co-authored-by: Ilya Lukyanovich <[email protected]>
Co-authored-by: Lucas Rogerio Caetano Ferreira <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation >FORK Related to the fork process Rename Renaming to OpenSearch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants