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

Review and update documentation (February Milestone) #16629

Closed
jsquire opened this issue Nov 5, 2020 · 0 comments
Closed

Review and update documentation (February Milestone) #16629

jsquire opened this issue Nov 5, 2020 · 0 comments
Labels
Client This issue points to a problem in the data-plane of the library. Docs Event Hubs

Comments

@jsquire
Copy link
Member

jsquire commented Nov 5, 2020

Summary

In preparation for the next milestone release of the Event Hubs client, the documentation which accompanies it should be reviewed for accuracy and any updates which are needed made.

Scope of Work

  • The document comments for the API surface exist and are accurate. Any needed updates to reflect the new retry options approach have been made.

  • The README content is up to date, accurate, and complete.

  • The CHANGELOG has been filled in for the release and contains the appropriate level of detail.

  • Update the release notes in the main Azure SDK library with the major call-outs from the Event Hubs change log.

Out of Scope

  • Updates or changes to samples; that will be covered under a dedicated workstream.

Success Criteria

  • The documentation detailed by the scope has been reviewed, updated, and is in a good state for release of the Event Hubs client library.

  • The package installation instructions points to the correct NuGet package.

@jsquire jsquire added Event Hubs Client This issue points to a problem in the data-plane of the library. Docs labels Nov 5, 2020
@jsquire jsquire added this to the [2021] February milestone Nov 5, 2020
@jsquire jsquire closed this as completed Feb 8, 2021
@github-actions github-actions bot locked and limited conversation to collaborators Mar 28, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Client This issue points to a problem in the data-plane of the library. Docs Event Hubs
Projects
None yet
Development

No branches or pull requests

1 participant