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.

Sign up for GitHub

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

Jump to bottom

[Event Hubs Client] Track Two (Release Documentation) #9296

Merged
merged 1 commit into from
Jan 3, 2020
Merged

[Event Hubs Client] Track Two (Release Documentation) #9296

merged 1 commit into from
Jan 3, 2020

Conversation

jsquire
Copy link
Member

@jsquire jsquire commented Jan 3, 2020

Summary

The focus of these changes is to revise and enhance the documentation in the README files for each of the Event Hubs packages and to provide details for
the change log. Versions have also been changed in the projects to match the change log.

Last Upstream Rebase

Friday, January 3, 1:32pm (EST)

Related and Follow-Up Issues

@jsquire jsquire added Event Hubs Client This issue points to a problem in the data-plane of the library. labels Jan 3, 2020
@jsquire jsquire added this to the [2020] January milestone Jan 3, 2020
@jsquire jsquire self-assigned this Jan 3, 2020
@jsquire jsquire mentioned this pull request Jan 3, 2020
Closed
@jsquire
Copy link
Member Author

jsquire commented Jan 3, 2020

This set of changes includes @ellismg's proposed examples for AAD from #9272.

jsquire
jsquire commented Jan 3, 2020
View reviewed changes
sdk/eventhub/Azure.Messaging.EventHubs/design/proposal-event-hubs-second-preview.md

- `EventHubsEventSource`
- `EventHubsDiagnosticSource`
# .NET Event Hubs Client: Track Two Proposal (Second Preview)
Copy link
Member Author

Choose a reason for hiding this comment

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

Not sure what is up with this one; the removal of the BOM prefix may have been preserved between branches. /shrug

ellismg
ellismg previously requested changes Jan 3, 2020
View reviewed changes
Copy link
Member

@ellismg ellismg left a comment

Choose a reason for hiding this comment

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

Found a few typos. Love the improvements! I assume that we are okay dropping the preview.X tag from the version at this point (I know we are shipping "soon", I just don't know if we had to wait longer for some reason)?

sdk/eventhub/Azure.Messaging.EventHubs.Processor/README.md Outdated Show resolved Hide resolved
sdk/eventhub/Azure.Messaging.EventHubs/README.md Outdated Show resolved Hide resolved
@jsquire
Copy link
Member Author

jsquire commented Jan 3, 2020 •
edited
Loading

Found a few typos. Love the improvements! I assume that we are okay dropping the preview.X tag from the version at this point (I know we are shipping "soon", I just don't know if we had to wait longer for some reason)?

If I put out a PR without typos, nobody would believe that I actually wrote it. 😛 Thank you, again, for the ideas and letting me absorb your work into this.

Packages get cut on Mon/Tues of next week. We could have done a specific release PR, but once we hit the code complete day (today), we're usually good with adopting the actual versioning for the release.

ShivangiReja
ShivangiReja approved these changes Jan 3, 2020
View reviewed changes
Copy link
Member

@ShivangiReja ShivangiReja left a comment

Choose a reason for hiding this comment

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

LGTM. Left few typos related comments.

sdk/eventhub/Azure.Messaging.EventHubs.Processor/README.md Outdated Show resolved Hide resolved
sdk/eventhub/Azure.Messaging.EventHubs/CHANGELOG.md Outdated Show resolved Hide resolved
sdk/eventhub/Azure.Messaging.EventHubs/README.md Outdated Show resolved Hide resolved
@jsquire
[Event Hubs Client] Track Two (Release Documentation)
acf2278 
The focus of these changes is to revise and enhance the documentation in the
README files for each of the Event Hubs packages and to provide details for
the change log.  Versions have also been changed in the projects to match the
change log.

Adding the generated public API surface for analysis during CI.
@jsquire jsquire requested a review from ellismg January 3, 2020 19:55
@jsquire jsquire dismissed ellismg’s stale review January 3, 2020 20:29

Feedback has been incorporated and was non-blocking; aiming to complete the PR before end of business, eastern.

@jsquire jsquire merged commit 81d7891 into Azure:master Jan 3, 2020
@jsquire jsquire deleted the eventhubs/docs branch January 3, 2020 20:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@chrisjbarr chrisjbarr chrisjbarr left review comments

@ShivangiReja ShivangiReja ShivangiReja approved these changes

@kinelski kinelski Awaiting requested review from kinelski

@AlexGhiondea AlexGhiondea Awaiting requested review from AlexGhiondea

@serkantkaraca serkantkaraca Awaiting requested review from serkantkaraca

@KrzysztofCwalina KrzysztofCwalina Awaiting requested review from KrzysztofCwalina

@pakrym pakrym Awaiting requested review from pakrym

@tg-msft tg-msft Awaiting requested review from tg-msft

@ellismg ellismg Awaiting requested review from ellismg

Assignees

@jsquire jsquire

Labels
Client This issue points to a problem in the data-plane of the library. Event Hubs
Projects
None yet
Milestone
[2020] January
Development

Successfully merging this pull request may close these issues.
4 participants
@jsquire @ellismg @chrisjbarr @ShivangiReja