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 #249

Closed
wants to merge 14 commits into from
Closed

Conversation

tlfeng
Copy link
Collaborator

@tlfeng tlfeng commented Mar 10, 2021

Issue #, if available:
#238

Description of changes:

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 be replaced easily
// TODO: Replace the setup code of 'stackoverflow' and 'news' for OpenSearch
// TODO: Replace the example for OpenSearch

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
Copy link

Request for Admin to accept this test.

@tlfeng tlfeng added documentation Improvements or additions to documentation Rename Renaming to OpenSearch labels Mar 11, 2021
@tlfeng tlfeng requested a review from setiah March 11, 2021 23:59
@tlfeng tlfeng added the >FORK Related to the fork process label Mar 12, 2021
Copy link
Contributor

@setiah setiah left a comment

Choose a reason for hiding this comment

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

Looks good. few minor comments.

I have also added replacing examples in the meta issue tracking purify docs, just so we don't miss it. It will be good to run opensearch server and try out example API calls and add them in examples

@@ -321,6 +321,7 @@ buildRestTests.doFirst {
buildRestTests.setups['bank'].replace('#bank_data#', accounts)
}

// TODO: Replace the setup code of 'stackoverflow' and 'news' for OpenSearch
Copy link
Contributor

@setiah setiah Mar 14, 2021

Choose a reason for hiding this comment

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

TODO(OpenSearch) instead?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Sure, it's a good idea! I will replace TODO with TODO(OpenSearch), and simplify the message after the colon:

Copy link
Contributor

@setiah setiah left a comment

Choose a reason for hiding this comment

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

Minor comment - can we use TODO(OpenSearch) instead of plain TODO, so we can revisit OpenSearch related tasks later

@odfe-release-bot
Copy link

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

@tlfeng
Copy link
Collaborator Author

tlfeng commented Mar 18, 2021

I will continue the work in PR #367

@tlfeng tlfeng closed this Mar 18, 2021
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