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

Add API Guides #279

Closed
6 tasks done
Tracked by #56
nhtruong opened this issue Apr 4, 2023 · 1 comment · Fixed by #302
Closed
6 tasks done
Tracked by #56

Add API Guides #279

nhtruong opened this issue Apr 4, 2023 · 1 comment · Fixed by #302
Labels
CCI enhancement New feature or request

Comments

@nhtruong
Copy link

nhtruong commented Apr 4, 2023

(Spawn off of meta Issue: opensearch-project/opensearch-clients#56)
To help drive adoption of OpenSearch, and improve user's experience, we're working on adding more documentation for all clients. One of the strategies mentioned in said issue is writing a collection of articles serving as a User's Guide for each client. This issue will serve as a hub for all issues related to this topic.

Each Guide/Article will be a good-first-issue for new contributors to work on. There's already a Ruby version of each article that the articles on this repo should be based upon. Most of the time, we only need to replace the Ruby code blocks with the client code of this repo. Please refer to the meta issue for more details.

@dblock
Copy link
Member

dblock commented Apr 14, 2023

@zethuman I linked user guides in #302

I noticed some inconsistencies in capitalization (e.g. ### Mix and match operations vs ### Update an Index) and language (e.g. Get Metadata vs. Indexing ...). Want to align those?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CCI enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants