-
Notifications
You must be signed in to change notification settings - Fork 504
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
Update version and add link to examples - Javascript client #4224
Conversation
Signed-off-by: Heather Halter <[email protected]>
Signed-off-by: Heather Halter <[email protected]>
Signed-off-by: Heather Halter <[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.
LGTM
@@ -7,7 +7,7 @@ nav_order: 2 | |||
|
|||
# Helper methods | |||
|
|||
Helper methods simplify the use of complicated API tasks. | |||
Helper methods simplify the use of complicated API tasks. For the client's complete API documentation and additional examples, see the [JS client API documentation](https://opensearch-project.github.io/opensearch-js/2.2/index.html). |
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'm not sure this is necessary since we have the same line in the index 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.
Even so, someone was looking for it on this page and gave feedback asking where it was. So it can't hurt...
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Heather Halter <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Heather Halter <[email protected]>
The backport to
To backport manually, run these commands in your terminal: # Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-1.3 1.3
# Navigate to the new working tree
pushd ../.worktrees/backport-1.3
# Create a new branch
git switch --create backport/backport-4224-to-1.3
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 09aa024b55f9ed59190f26567552eff298a9812f
# Push it to GitHub
git push --set-upstream origin backport/backport-4224-to-1.3
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-1.3 Then, create a pull request where the |
The backport to
To backport manually, run these commands in your terminal: # Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-2.8 2.8
# Navigate to the new working tree
pushd ../.worktrees/backport-2.8
# Create a new branch
git switch --create backport/backport-4224-to-2.8
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 09aa024b55f9ed59190f26567552eff298a9812f
# Push it to GitHub
git push --set-upstream origin backport/backport-4224-to-2.8
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.8 Then, create a pull request where the |
* addlinktoguides Signed-off-by: Heather Halter <[email protected]> * addslinktohelperfile Signed-off-by: Heather Halter <[email protected]> * addedlinktohelper Signed-off-by: Heather Halter <[email protected]> * Update _clients/javascript/index.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Heather Halter <[email protected]> * Update _clients/javascript/helpers.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Heather Halter <[email protected]> --------- Signed-off-by: Heather Halter <[email protected]> Signed-off-by: Heather Halter <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> (cherry picked from commit 09aa024)
The backport to
To backport manually, run these commands in your terminal: # Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-2.8 2.8
# Navigate to the new working tree
pushd ../.worktrees/backport-2.8
# Create a new branch
git switch --create backport/backport-4224-to-2.8
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 09aa024b55f9ed59190f26567552eff298a9812f
# Push it to GitHub
git push --set-upstream origin backport/backport-4224-to-2.8
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.8 Then, create a pull request where the |
* addlinktoguides Signed-off-by: Heather Halter <[email protected]> * addslinktohelperfile Signed-off-by: Heather Halter <[email protected]> * addedlinktohelper Signed-off-by: Heather Halter <[email protected]> * Update _clients/javascript/index.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Heather Halter <[email protected]> * Update _clients/javascript/helpers.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Heather Halter <[email protected]> --------- Signed-off-by: Heather Halter <[email protected]> Signed-off-by: Heather Halter <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> (cherry picked from commit 09aa024)
The backport to
To backport manually, run these commands in your terminal: # Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-2.8 2.8
# Navigate to the new working tree
pushd ../.worktrees/backport-2.8
# Create a new branch
git switch --create backport/backport-4224-to-2.8
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 09aa024b55f9ed59190f26567552eff298a9812f
# Push it to GitHub
git push --set-upstream origin backport/backport-4224-to-2.8
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.8 Then, create a pull request where the |
…ch-project#4224) * addlinktoguides Signed-off-by: Heather Halter <[email protected]> * addslinktohelperfile Signed-off-by: Heather Halter <[email protected]> * addedlinktohelper Signed-off-by: Heather Halter <[email protected]> * Update _clients/javascript/index.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Heather Halter <[email protected]> * Update _clients/javascript/helpers.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Heather Halter <[email protected]> --------- Signed-off-by: Heather Halter <[email protected]> Signed-off-by: Heather Halter <[email protected]> Co-authored-by: kolchfa-aws <[email protected]>
Description
Updates the JS version of the API docs to 2.2 and adds a link to Github where samples reside.
Issues Resolved
Resolves opensearch-project/opensearch-js#437
Resolves opensearch-project/opensearch-js#458
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.