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 handlers for read, update, and delete to CREATE_YOUR_FIRST_EXTENSION doc #864

Merged
merged 9 commits into from
Jul 11, 2023

Conversation

dbwiddis
Copy link
Member

@dbwiddis dbwiddis commented Jul 9, 2023

Description

Updates CREATE_YOUR_FIRST_EXTENSION with the RUD part of CRUD (and a better C example). Also fixes the internal links broken in earlier reviews.

Please merge #827 (and then rebase this PR) prior to merging this PR, as this builds on updates from that PR to Named Routes.

Reference project implementing this, with the code tested: https://github.com/dbwiddis/CRUDExtension

Issues Resolved

Part of #836 (Documentation)

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.

Signed-off-by: Daniel Widdis <widdis@gmail.com>
owaiskazi19
owaiskazi19 previously approved these changes Jul 9, 2023
Signed-off-by: Daniel Widdis <widdis@gmail.com>
Signed-off-by: Daniel Widdis <widdis@gmail.com>
@dbwiddis dbwiddis requested a review from owaiskazi19 July 9, 2023 17:15
owaiskazi19
owaiskazi19 previously approved these changes Jul 9, 2023
Signed-off-by: Daniel Widdis <widdis@gmail.com>
joshpalis
joshpalis previously approved these changes Jul 10, 2023
Copy link
Contributor

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

A couple of comments, mainly making the document more user-centric. Thanks!

CREATE_YOUR_FIRST_EXTENSION.md Outdated Show resolved Hide resolved
CREATE_YOUR_FIRST_EXTENSION.md Outdated Show resolved Hide resolved
CREATE_YOUR_FIRST_EXTENSION.md Outdated Show resolved Hide resolved
CREATE_YOUR_FIRST_EXTENSION.md Outdated Show resolved Hide resolved
CREATE_YOUR_FIRST_EXTENSION.md Outdated Show resolved Hide resolved
CREATE_YOUR_FIRST_EXTENSION.md Outdated Show resolved Hide resolved
CREATE_YOUR_FIRST_EXTENSION.md Outdated Show resolved Hide resolved
CREATE_YOUR_FIRST_EXTENSION.md Outdated Show resolved Hide resolved
Copy link
Contributor

@natebower natebower left a comment

Choose a reason for hiding this comment

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

A few more comments, some similar to @kolchfa-aws but with an addition or two. Thanks!

CREATE_YOUR_FIRST_EXTENSION.md Outdated Show resolved Hide resolved
CREATE_YOUR_FIRST_EXTENSION.md Outdated Show resolved Hide resolved
CREATE_YOUR_FIRST_EXTENSION.md Outdated Show resolved Hide resolved
CREATE_YOUR_FIRST_EXTENSION.md Outdated Show resolved Hide resolved
CREATE_YOUR_FIRST_EXTENSION.md Outdated Show resolved Hide resolved
CREATE_YOUR_FIRST_EXTENSION.md Outdated Show resolved Hide resolved
CREATE_YOUR_FIRST_EXTENSION.md Outdated Show resolved Hide resolved
CREATE_YOUR_FIRST_EXTENSION.md Outdated Show resolved Hide resolved
@dbwiddis
Copy link
Member Author

A couple of comments, mainly making the document more user-centric. Thanks!

Thanks! Can you tell I spent way too long in academia where "we" is the standard? :)

Signed-off-by: Daniel Widdis <widdis@gmail.com>
@kolchfa-aws
Copy link
Contributor

Yes, "we" when we're doing an experiment, and "you" when you want the user to do something :)

@owaiskazi19
Copy link
Member

@kolchfa-aws @natebower looks good to you before we merge the changes in?

@kolchfa-aws
Copy link
Contributor

LGTM 😄

@owaiskazi19 owaiskazi19 merged commit 67046b2 into opensearch-project:main Jul 11, 2023
7 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jul 11, 2023
…ION doc (#864)

* Add handlers for read, update, and delete

Signed-off-by: Daniel Widdis <widdis@gmail.com>

* Remove reference to SDKClient

Signed-off-by: Daniel Widdis <widdis@gmail.com>

* Add link to TOC

Signed-off-by: Daniel Widdis <widdis@gmail.com>

* Replace we with you and only use one space after a full stop

Signed-off-by: Daniel Widdis <widdis@gmail.com>

---------

Signed-off-by: Daniel Widdis <widdis@gmail.com>
Co-authored-by: Owais Kazi <owaiskazi19@gmail.com>
(cherry picked from commit 67046b2)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
dbwiddis pushed a commit that referenced this pull request Jul 12, 2023
…ION doc (#864) (#878)

* Add handlers for read, update, and delete



* Remove reference to SDKClient



* Add link to TOC



* Replace we with you and only use one space after a full stop



---------



(cherry picked from commit 67046b2)

Signed-off-by: Daniel Widdis <widdis@gmail.com>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Owais Kazi <owaiskazi19@gmail.com>
DarshitChanpura pushed a commit to DarshitChanpura/opensearch-sdk-java that referenced this pull request Jul 12, 2023
…ION doc (opensearch-project#864) (opensearch-project#878)

* Add handlers for read, update, and delete

* Remove reference to SDKClient

* Add link to TOC

* Replace we with you and only use one space after a full stop

---------

(cherry picked from commit 67046b2)

Signed-off-by: Daniel Widdis <widdis@gmail.com>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Owais Kazi <owaiskazi19@gmail.com>
DarshitChanpura pushed a commit to DarshitChanpura/opensearch-sdk-java that referenced this pull request Jul 12, 2023
…ION doc (opensearch-project#864) (opensearch-project#878)

* Add handlers for read, update, and delete

* Remove reference to SDKClient

* Add link to TOC

* Replace we with you and only use one space after a full stop

---------

(cherry picked from commit 67046b2)

Signed-off-by: Daniel Widdis <widdis@gmail.com>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Owais Kazi <owaiskazi19@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants