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

Update version and add link to examples - Javascript client #4224

Merged
merged 5 commits into from
Jun 6, 2023

Conversation

hdhalter
Copy link
Contributor

@hdhalter hdhalter commented Jun 2, 2023

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

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

Signed-off-by: Heather Halter <[email protected]>
@hdhalter hdhalter self-assigned this Jun 2, 2023
@hdhalter hdhalter added 4 - Doc review PR: Doc review in progress backport 2.7 PR: Backport label for 2.7 labels Jun 2, 2023
Signed-off-by: Heather Halter <[email protected]>
@hdhalter hdhalter marked this pull request as draft June 2, 2023 20:18
Signed-off-by: Heather Halter <[email protected]>
@hdhalter hdhalter marked this pull request as ready for review June 2, 2023 20:38
Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a 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).
Copy link
Collaborator

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.

Copy link
Contributor Author

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...

_clients/javascript/index.md Outdated Show resolved Hide resolved
_clients/javascript/helpers.md Outdated Show resolved Hide resolved
hdhalter and others added 2 commits June 6, 2023 15:46
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]>
@hdhalter hdhalter added backport 2.8 PR: Backport label for 2.8 backport 1.3 PR: Backport label for v1.3.x and removed backport 2.7 PR: Backport label for 2.7 labels Jun 6, 2023
@hdhalter hdhalter merged commit 09aa024 into main Jun 6, 2023
@opensearch-trigger-bot
Copy link
Contributor

The backport to 1.3 failed:

The process '/usr/bin/git' failed with exit code 128

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 base branch is 1.3 and the compare/head branch is backport/backport-4224-to-1.3.

@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.8 failed:

The process '/usr/bin/git' failed with exit code 1

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 base branch is 2.8 and the compare/head branch is backport/backport-4224-to-2.8.

@hdhalter hdhalter removed the backport 1.3 PR: Backport label for v1.3.x label Jun 6, 2023
hdhalter added a commit that referenced this pull request Jun 6, 2023
* 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)
@hdhalter hdhalter added backport 2.8 PR: Backport label for 2.8 and removed backport 2.8 PR: Backport label for 2.8 labels Jun 6, 2023
@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.8 failed:

The process '/usr/bin/git' failed with exit code 1

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 base branch is 2.8 and the compare/head branch is backport/backport-4224-to-2.8.

hdhalter added a commit that referenced this pull request Jun 6, 2023
* 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)
@hdhalter hdhalter added backport 2.8 PR: Backport label for 2.8 and removed backport 2.8 PR: Backport label for 2.8 labels Jun 6, 2023
@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.8 failed:

The process '/usr/bin/git' failed with exit code 128

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 base branch is 2.8 and the compare/head branch is backport/backport-4224-to-2.8.

harshavamsi pushed a commit to harshavamsi/documentation-website that referenced this pull request Oct 31, 2023
…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]>
@hdhalter hdhalter deleted the updatejavascriptfile branch March 28, 2024 21:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
4 - Doc review PR: Doc review in progress backport 2.8 PR: Backport label for 2.8
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FEATURE] Feedback on Javascript documentation [BUG] Feedback on Javascript client documentation
2 participants