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

index lifecycle guide added #457

Closed

Conversation

govegito
Copy link

Description

Index life cycle guide created

Issues Resolved

Guide] Index Lifecycle #428

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@dblock
Copy link
Member

dblock commented Apr 24, 2023

Please fix DCO to start @govegito (git commit --amend -s).

@govegito
Copy link
Author

@dblock DCO done ✅

@reta
Copy link
Collaborator

reta commented May 1, 2023

@dblock DCO done ✅

Hm ... @govegito the check is still failing :(

@dblock
Copy link
Member

dblock commented May 1, 2023

@govegito let us know if you need any help? All the commits need to have DCO. One way to fix it is this:

git checkout fix_issue_428_backup # make a backup branch just in case ;)
git checkout fix_issue_428
git reset HEAD~4 # rewinds your commits without deleting the changes
git add .
git commit -s -m "..." # commit with proper signature
git push origin fix_issue_428 -f # force push an update

@govegito govegito force-pushed the govegito/fix_issue_428 branch from 97421de to cb89f27 Compare May 13, 2023 05:27
@govegito govegito requested a review from szczepanczykd as a code owner May 13, 2023 05:27
@govegito
Copy link
Author

@dblock @reta DCO check is passing now.

This code example uses basic credentials that come with the default OpenSearch configuration.If you’re using the Java client with your own OpenSearch cluster, be sure to change the code so that it uses your own credentials.

```java
final CredentialsProvider credentialsProvider = new BasicCredentialsProvider();
Copy link
Collaborator

Choose a reason for hiding this comment

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

@govegito this snippet it not valid for main branch since it should be using Apache HttpClient 5 APIs, I think the best option is to retarget the pull request to 2.x branch and than have another pull request for main.

Copy link
Author

Choose a reason for hiding this comment

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

Understood, retargeting it to 2.x branch.

guides/index_lifecycle.md Show resolved Hide resolved
guides/index_lifecycle.md Show resolved Hide resolved
guides/index_lifecycle.md Show resolved Hide resolved
guides/index_lifecycle.md Show resolved Hide resolved
guides/index_lifecycle.md Show resolved Hide resolved
guides/index_lifecycle.md Show resolved Hide resolved
@@ -0,0 +1,152 @@
# Index Lifecycle
This guide covers OpenSearch Java Client API actions for Index Lifecycle. You'll learn how to create, read, update, and delete indices in your OpenSearch cluster. We will also leverage index templates to create default settings and mappings for indices of certain patterns.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
This guide covers OpenSearch Java Client API actions for Index Lifecycle. You'll learn how to create, read, update, and delete indices in your OpenSearch cluster. We will also leverage index templates to create default settings and mappings for indices of certain patterns.
This guide covers OpenSearch Java Client API actions for Index Lifecycle. You'll learn how to create, update, and delete indices in your OpenSearch cluster as well as got to index, search and delete the data within the index.

Copy link
Collaborator

Choose a reason for hiding this comment

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

There is no index template in the guide.

Copy link
Author

Choose a reason for hiding this comment

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

According to the description of the issue Java guide similar to ruby guide has to be made, and in this ruby guide there were only crud operations.
If template needs to be added in the guide please help me with some proper documentation meanwhile i followed this doc for creating this guide.

@dblock
Copy link
Member

dblock commented Dec 4, 2023

@govegito Want to finish this?

@VachaShah
Copy link
Collaborator

These samples are added to USER_GUIDE when the documentation was updated. Closing this PR. Thanks @govegito!

@VachaShah VachaShah closed this Feb 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants