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

[FEATURE] Feedback on Javascript documentation #458

Closed
hdhalter opened this issue Mar 24, 2023 · 5 comments · Fixed by opensearch-project/documentation-website#4224
Closed

Comments

@hdhalter
Copy link

Is your feature request related to a problem?

We've gotten feedback on this topic: /docs/2.4/clients/javascript/index/

What solution would you like?

Feedback was "Missing descriptions on how to use bulk indexing"

What alternatives have you considered?

We got a similar request on /docs/latest/clients/java-rest-high-level/: "I am looking for bulk api"

Do you have any additional context?

Are there docs we can link to? Thanks.

Add any other context or screenshots about the feature request here.

@nhtruong
Copy link
Collaborator

@hdhalter thanks for letting us know. This article might be what you're looking for https://github.com/opensearch-project/documentation-website/blob/ede405c85dbeda4c4fbc21423e2477c2102640e3/_clients/javascript/helpers.md. Let me know if it's not.

@hdhalter
Copy link
Author

In your opinion, does the content in helpers.md address the user's concern for examples? The page they commented on (https://opensearch.org/docs/latest/clients/javascript/index/) does link to that helpers.md page. If the content is sufficient, maybe we can move the link to the page up to the top of the page so it's more findable?

@nhtruong
Copy link
Collaborator

I think it does address what the user is looking for. And I agree, visibility is the issue here. We should either mention that bulk in in the helper article or merge the helper article into the index one since it's not that big.

@hdhalter
Copy link
Author

Ok, thanks for taking a look! I'll get this addressed and comment back in this issue once we've resolved it.

@nhtruong
Copy link
Collaborator

We've added a series of guides. This is is about Bulk: https://github.com/opensearch-project/opensearch-js/blob/main/guides/bulk.md

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 a pull request may close this issue.

2 participants