-
Notifications
You must be signed in to change notification settings - Fork 187
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
Adding bulk api docs to getting_started #187
Adding bulk api docs to getting_started #187
Conversation
Signed-off-by: Harsha Vamsi Kalluri <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lets also add a description to the PR according to the PR template?
.gitignore
Outdated
@@ -142,3 +142,10 @@ cython_debug/ | |||
test_opensearch/cover | |||
test_opensearch/local.py | |||
.ci/output | |||
|
|||
# Local test file |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are these generated files or just something for your local testing?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep, adding some local files for testing. These are just gitignored.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No I meant since this is not part of repo, lets not add them here as they are for local testing.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed.
Signed-off-by: Harsha Vamsi Kalluri <[email protected]>
Signed-off-by: Harsha Vamsi Kalluri <[email protected]>
GETTING_STARTED.md
Outdated
client.bulk(docs) | ||
|
||
|
||
# Bulk index documents using the helper function |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider breaking up the samples into sections with their own code blocks?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@dblock separated the docs, wdyt?
Signed-off-by: Harsha Vamsi Kalluri <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd prefer for Titles to Be Capitalized Like This, but this is totally personal, this looks great! :)
Signed-off-by: Harsha Vamsi Kalluri [email protected]
Description
Adds examples on how to use bulk api through client and helpers.
Issues Resolved
List any issues this PR will resolve, e.g. Closes [...].
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.