Skip to content

[DOCS] Adds Examples section to .NET docs #6418

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

Merged
merged 9 commits into from
Sep 29, 2022

Conversation

szabosteve
Copy link
Contributor

@szabosteve szabosteve commented May 24, 2022

Overview

This PR adds an Examples section to the .NET documentation that contains code snippets showing how to execute CRUD operations.

Preview

Examples

@szabosteve szabosteve added Docs 8.x Relates to a 8.x client version labels May 24, 2022
Copy link
Contributor

@stevejgordon stevejgordon left a comment

Choose a reason for hiding this comment

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

The API is a little in-flux still so we will need to revisit the samples. I can assist with filling in the update and delete documents. A few initial comments on know changes based on current alpha code.

@szabosteve szabosteve marked this pull request as ready for review September 29, 2022 14:38
Copy link
Contributor

@stevejgordon stevejgordon left a comment

Choose a reason for hiding this comment

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

LGTM!

@stevejgordon stevejgordon merged commit a945680 into elastic:main Sep 29, 2022
stevejgordon added a commit that referenced this pull request Sep 29, 2022
* [DOCS] Adds Examples section to .NET docs.

* [DOCS] Fixe index file.

* [DOCS] Fixes index file.

* [DOCS] Further changes.

* Expand documentation and add missing examples

* Use consistant wording when referring to 'a' document.

* [DOCS] Changes line breaks.

* Refer to tweet type correctly in all locations

Co-authored-by: Steve Gordon <[email protected]>
(cherry picked from commit a945680)
stevejgordon added a commit that referenced this pull request Sep 29, 2022
* [DOCS] Adds Examples section to .NET docs.

* [DOCS] Fixe index file.

* [DOCS] Fixes index file.

* [DOCS] Further changes.

* Expand documentation and add missing examples

* Use consistant wording when referring to 'a' document.

* [DOCS] Changes line breaks.

* Refer to tweet type correctly in all locations

Co-authored-by: Steve Gordon <[email protected]>
(cherry picked from commit a945680)

Co-authored-by: István Zoltán Szabó <[email protected]>
github-actions bot pushed a commit that referenced this pull request Sep 29, 2022
* [DOCS] Adds Examples section to .NET docs.

* [DOCS] Fixe index file.

* [DOCS] Fixes index file.

* [DOCS] Further changes.

* Expand documentation and add missing examples

* Use consistant wording when referring to 'a' document.

* [DOCS] Changes line breaks.

* Refer to tweet type correctly in all locations

Co-authored-by: Steve Gordon <[email protected]>
(cherry picked from commit a945680)

Co-authored-by: István Zoltán Szabó <[email protected]>
github-actions bot pushed a commit that referenced this pull request Sep 29, 2022
* [DOCS] Adds Examples section to .NET docs.

* [DOCS] Fixe index file.

* [DOCS] Fixes index file.

* [DOCS] Further changes.

* Expand documentation and add missing examples

* Use consistant wording when referring to 'a' document.

* [DOCS] Changes line breaks.

* Refer to tweet type correctly in all locations

Co-authored-by: Steve Gordon <[email protected]>
(cherry picked from commit a945680)

Co-authored-by: István Zoltán Szabó <[email protected]>
github-actions bot pushed a commit that referenced this pull request Sep 29, 2022
* [DOCS] Adds Examples section to .NET docs.

* [DOCS] Fixe index file.

* [DOCS] Fixes index file.

* [DOCS] Further changes.

* Expand documentation and add missing examples

* Use consistant wording when referring to 'a' document.

* [DOCS] Changes line breaks.

* Refer to tweet type correctly in all locations

Co-authored-by: Steve Gordon <[email protected]>
(cherry picked from commit a945680)

Co-authored-by: István Zoltán Szabó <[email protected]>
github-actions bot pushed a commit that referenced this pull request Sep 29, 2022
* [DOCS] Adds Examples section to .NET docs.

* [DOCS] Fixe index file.

* [DOCS] Fixes index file.

* [DOCS] Further changes.

* Expand documentation and add missing examples

* Use consistant wording when referring to 'a' document.

* [DOCS] Changes line breaks.

* Refer to tweet type correctly in all locations

Co-authored-by: Steve Gordon <[email protected]>
(cherry picked from commit a945680)

Co-authored-by: István Zoltán Szabó <[email protected]>
github-actions bot pushed a commit that referenced this pull request Sep 29, 2022
* [DOCS] Adds Examples section to .NET docs.

* [DOCS] Fixe index file.

* [DOCS] Fixes index file.

* [DOCS] Further changes.

* Expand documentation and add missing examples

* Use consistant wording when referring to 'a' document.

* [DOCS] Changes line breaks.

* Refer to tweet type correctly in all locations

Co-authored-by: Steve Gordon <[email protected]>
(cherry picked from commit a945680)

Co-authored-by: István Zoltán Szabó <[email protected]>
stevejgordon added a commit that referenced this pull request Sep 30, 2022
* [DOCS] Adds Examples section to .NET docs.

* [DOCS] Fixe index file.

* [DOCS] Fixes index file.

* [DOCS] Further changes.

* Expand documentation and add missing examples

* Use consistant wording when referring to 'a' document.

* [DOCS] Changes line breaks.

* Refer to tweet type correctly in all locations

Co-authored-by: Steve Gordon <[email protected]>
(cherry picked from commit a945680)

Co-authored-by: István Zoltán Szabó <[email protected]>

Co-authored-by: Steve Gordon <[email protected]>
Co-authored-by: István Zoltán Szabó <[email protected]>
stevejgordon added a commit that referenced this pull request Sep 30, 2022
* [DOCS] Adds Examples section to .NET docs.

* [DOCS] Fixe index file.

* [DOCS] Fixes index file.

* [DOCS] Further changes.

* Expand documentation and add missing examples

* Use consistant wording when referring to 'a' document.

* [DOCS] Changes line breaks.

* Refer to tweet type correctly in all locations

Co-authored-by: Steve Gordon <[email protected]>
(cherry picked from commit a945680)

Co-authored-by: István Zoltán Szabó <[email protected]>

Co-authored-by: Steve Gordon <[email protected]>
Co-authored-by: István Zoltán Szabó <[email protected]>
stevejgordon added a commit that referenced this pull request Sep 30, 2022
* [DOCS] Adds Examples section to .NET docs.

* [DOCS] Fixe index file.

* [DOCS] Fixes index file.

* [DOCS] Further changes.

* Expand documentation and add missing examples

* Use consistant wording when referring to 'a' document.

* [DOCS] Changes line breaks.

* Refer to tweet type correctly in all locations

Co-authored-by: Steve Gordon <[email protected]>
(cherry picked from commit a945680)

Co-authored-by: István Zoltán Szabó <[email protected]>

Co-authored-by: Steve Gordon <[email protected]>
Co-authored-by: István Zoltán Szabó <[email protected]>
stevejgordon added a commit that referenced this pull request Sep 30, 2022
* [DOCS] Adds Examples section to .NET docs.

* [DOCS] Fixe index file.

* [DOCS] Fixes index file.

* [DOCS] Further changes.

* Expand documentation and add missing examples

* Use consistant wording when referring to 'a' document.

* [DOCS] Changes line breaks.

* Refer to tweet type correctly in all locations

Co-authored-by: Steve Gordon <[email protected]>
(cherry picked from commit a945680)

Co-authored-by: István Zoltán Szabó <[email protected]>

Co-authored-by: Steve Gordon <[email protected]>
Co-authored-by: István Zoltán Szabó <[email protected]>
stevejgordon added a commit that referenced this pull request Sep 30, 2022
* [DOCS] Adds Examples section to .NET docs.

* [DOCS] Fixe index file.

* [DOCS] Fixes index file.

* [DOCS] Further changes.

* Expand documentation and add missing examples

* Use consistant wording when referring to 'a' document.

* [DOCS] Changes line breaks.

* Refer to tweet type correctly in all locations

Co-authored-by: Steve Gordon <[email protected]>
(cherry picked from commit a945680)

Co-authored-by: István Zoltán Szabó <[email protected]>

Co-authored-by: Steve Gordon <[email protected]>
Co-authored-by: István Zoltán Szabó <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.x Relates to a 8.x client version
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants