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 #184

Open
4 of 6 tasks
Tracked by #56
nhtruong opened this issue Apr 4, 2023 · 4 comments
Open
4 of 6 tasks
Tracked by #56

Add API Guides #184

nhtruong opened this issue Apr 4, 2023 · 4 comments
Labels
CCI College Contributor Initiative documentation Improvements or additions to documentation

Comments

@nhtruong
Copy link
Contributor

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.

@nhtruong nhtruong added enhancement New feature or request untriaged and removed untriaged labels Apr 4, 2023
@Xtansia Xtansia added documentation Improvements or additions to documentation and removed enhancement New feature or request labels Apr 10, 2023
@nhtruong nhtruong added the CCI College Contributor Initiative label Jul 12, 2023
@Djcarrillo6
Copy link
Contributor

Hi Thomas, when you have a moment I'd like to have this issue assigned to me. Thanks

@Xtansia
Copy link
Collaborator

Xtansia commented Oct 9, 2023

@Djcarrillo6 Maybe comment on the issue for the specific guide you'd like to work on first, so that others can pick up other guides too if they want?

@Djcarrillo6
Copy link
Contributor

For sure @Xtansia , I'd like to work on #187 first..

@Xtansia
Copy link
Collaborator

Xtansia commented Oct 9, 2023

For sure @Xtansia , I'd like to work on #187 first..

@Djcarrillo6 sorry, you need to comment on #187 itself, due to the way Github works, I can't assign it to you unless you "participate" on that actual issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CCI College Contributor Initiative documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants