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

Release v8 docs #1599

Merged
merged 3 commits into from
Sep 27, 2023
Merged

Release v8 docs #1599

merged 3 commits into from
Sep 27, 2023

Conversation

martintmk
Copy link
Contributor

@martintmk martintmk commented Sep 19, 2023

Details on the issue fix or feature implementation

Closes #1091
Closes #1054

Confirm the following

  • I started this PR by branching from the head of the default branch
  • I have targeted the PR to merge into the default branch
  • I have included unit tests for the issue/feature
  • I have successfully run a local build

@martintmk martintmk added the v8 Issues related to the new version 8 of the Polly library. label Sep 19, 2023
@martintmk martintmk added this to the v8.0.0 milestone Sep 19, 2023
@codecov
Copy link

codecov bot commented Sep 19, 2023

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (32aa4bc) 84.63% compared to head (3a36379) 84.63%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1599   +/-   ##
=======================================
  Coverage   84.63%   84.63%           
=======================================
  Files         306      306           
  Lines        6819     6819           
  Branches     1045     1045           
=======================================
  Hits         5771     5771           
  Misses        839      839           
  Partials      209      209           
Flag Coverage Δ
macos 84.63% <ø> (ø)
windows 84.63% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@martincostello
Copy link
Member

@martintmk This just needs the merge conflicts resolving and then I think this is ready to merge and then we're done, right?

@martincostello martincostello mentioned this pull request Sep 27, 2023
17 tasks
@martintmk
Copy link
Contributor Author

@martintmk This just needs the merge conflicts resolving and then I think this is ready to merge and then we're done, right?

Do you think we should merge this even before v8.0.0 is released?

@martincostello
Copy link
Member

Yes because the README is embedded in the NuGet packages and it should be the v8 one, not the v7 one.

Also there's going to be not much lag between merging this and shipping (hopefully), plus it's nicer (IMHO) for the Git tag for 8.0.0 to contain the matching documentation.

@martintmk martintmk marked this pull request as ready for review September 27, 2023 13:14
@martintmk
Copy link
Contributor Author

Yes because the README is embedded in the NuGet packages and it should be the v8 one, not the v7 one.

Also there's going to be not much lag between merging this and shipping (hopefully), plus it's nicer (IMHO) for the Git tag for 8.0.0 to contain the matching documentation.

Ok, making this ready for review. v7 users will still have not pointing to older documentation on the top.

Copy link
Member

@martincostello martincostello left a comment

Choose a reason for hiding this comment

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

Just spotted this one typo.

README.md Outdated Show resolved Hide resolved
martintmk and others added 2 commits September 27, 2023 15:17
Update the NuGet package README to point to polldocs.org.
@martincostello
Copy link
Member

I just realised that the NuGet package actually has its own README file to fix rendering issues in NuGet for the gallery's Content Security Policy. I've updated it to point to pollydocs.org instead of the wiki.

@martintmk martintmk enabled auto-merge (squash) September 27, 2023 13:25
@martintmk martintmk merged commit 1296756 into main Sep 27, 2023
14 checks passed
@martintmk martintmk deleted the mtomka/docs-v8-release branch September 27, 2023 14:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation v8 Issues related to the new version 8 of the Polly library.
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

v8 API documentation Readme improvement
2 participants