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

Adds various client docs within Opensearch client #204

Merged
merged 1 commit into from
Sep 27, 2022

Conversation

jaydm26
Copy link
Contributor

@jaydm26 jaydm26 commented Sep 23, 2022

Description

This PR adds documentation to Sphinx for the clients within the Opensearch client. To include this, the docs were slightly restructured.

Issues Resolved

Addresses #171 by adding docs for clients included within the Opensearch client.

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

@jaydm26 jaydm26 requested review from a team, axeoman and deztructor as code owners September 23, 2022 17:33
@jaydm26 jaydm26 force-pushed the additional-clients-docs branch from 4149425 to be23a48 Compare September 23, 2022 17:38
Signed-off-by: Jay Mehta <[email protected]>
Signed-off-by: Jay Mehta <[email protected]>
@harshavamsi
Copy link
Collaborator

LGTM! Thanks so much for this!

@VachaShah @wbeckler let's get this merged?

Copy link
Collaborator

@VachaShah VachaShah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @jaydm26 for adding this! I built the Sphinx website on my local but I do not see these changes being incorporated. Is there something missing?

@harshavamsi
Copy link
Collaborator

@VachaShah I see them.

image

@VachaShah
Copy link
Collaborator

@VachaShah I see them.

image

Oh my bad! I think I was looking at the wrong place. Thanks!

@dblock dblock merged commit 9398975 into opensearch-project:main Sep 27, 2022
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 this pull request may close these issues.

4 participants