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

[Docs] Revise migration guide 3/3 #1775

Merged
merged 4 commits into from
Nov 3, 2023

Conversation

peter-csala
Copy link
Contributor

@peter-csala peter-csala commented Nov 3, 2023

Pull Request

The issue or feature being addressed

Details on the issue fix or feature implementation

  • Fixed a typo in resilience-pipeline-registry.md

  • Fixed the tip of the migration of retry policies

  • Fixed circuit breaker V8's warning about discontinued support for classic CB

  • Get rid of the Migrating other policies section because it just echoed previous statements

  • Migrating `Polly.Context

    • Replaced the bullet listed predefined key mapping with a tabular fashion one
    • Added a new list item about ResiliencePropertyKey
    • Extended the samples with the Bulk attach scenario
    • Introduced constants for the context keys
    • Added a tip section to the end
  • Migrating safe execution

    • Fixed a typo
    • Introduced constants for the context keys
    • Added a note about the discontinued support for sync safe method
    • Added a tip section to the end
  • Migrating no-op policies

    • Replaced bullet listed format to a tabular one
    • Replaced T to TResult for clarity
  • Migrating policy registries

    • Reordered the interfaces to follow alphabetical order
    • Replaced T to TKey for clarity
    • Introduced constants for the registry keys
    • Moved the add samples before the retrieval samples
    • Added a note about no direct update support
    • Added a tip section to the end
  • Interoperability between policies and resilience pipeline

    • Rephrased the paragraph

Open question(s)

  • When I deleted the Migrating other policies section then I was thinking:
    • "Shall we add here a statement about the cache policy?"
    • What do you guys think?

Answer: Do not mention

  • Regarding to the Migrating safe execution
    • I did not found any documentation about the state
    • I think we should capture somewhere how does it differ from the context?; when to use which?
    • Shall we create a dedicated page with samples?
    • Or is it enough to answer the above questions with two sentences?

Answer: Extend the resilience pipelines page

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

Copy link

codecov bot commented Nov 3, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (9e86a0a) 84.53% compared to head (16716cf) 84.53%.
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1775   +/-   ##
=======================================
  Coverage   84.53%   84.53%           
=======================================
  Files         307      307           
  Lines        6777     6777           
  Branches     1043     1043           
=======================================
  Hits         5729     5729           
  Misses        839      839           
  Partials      209      209           
Flag Coverage Δ
linux 84.53% <ø> (ø)
macos 84.53% <ø> (ø)
windows 84.53% <ø> (ø)

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.

@martintmk
Copy link
Contributor

@peter-csala thanks again for a great content!

Here is what I think:

"Shall we add here a statement about the cache policy?"

I would say so, it's better than not to mention anything.

I did not found any documentation about the state I think we should capture somewhere how does it differ from the context?; when to use which? Shall we create a dedicated page with samples?

I don't think state is something we need to mention in migration guide as it is a concept new to v8.

There is already briefly mentioned here:
https://www.pollydocs.org/advanced/performance.html#use-static-lambdas

But maybe we should expand the resilience pipeline docs with new "Executing pipeline" section where we can describe state too:
https://www.pollydocs.org/pipelines/index.html

docs/migration-v8.md Outdated Show resolved Hide resolved
@peter-csala
Copy link
Contributor Author

But maybe we should expand the resilience pipeline docs with new "Executing pipeline" section where we can describe state too: https://www.pollydocs.org/pipelines/index.html

I agree that would be a great place for that.

@peter-csala peter-csala marked this pull request as ready for review November 3, 2023 10:00
docs/migration-v8.md Outdated Show resolved Hide resolved
Co-authored-by: Martin Costello <[email protected]>
@martintmk martintmk merged commit 41fd38c into App-vNext:main Nov 3, 2023
18 checks passed
@peter-csala
Copy link
Contributor Author

But maybe we should expand the resilience pipeline docs with new "Executing pipeline" section where we can describe state too: https://www.pollydocs.org/pipelines/index.html

I agree that would be a great place for that.

@martintmk Will you create a PR for ☝️ ?

@martintmk
Copy link
Contributor

But maybe we should expand the resilience pipeline docs with new "Executing pipeline" section where we can describe state too: https://www.pollydocs.org/pipelines/index.html

I agree that would be a great place for that.

@martintmk Will you create a PR for ☝️ ?

I won't be able this week, will try get to it next one. You can take a shot at it if you want.

@peter-csala
Copy link
Contributor Author

I won't be able this week, will try get to it next one. You can take a shot at it if you want.

I am on parental leave in November as my second son was born on Monday. I will have really limited presence here in the next 3-4 weeks. If you won't have time for this during November then I will give it a try in December.

@martintmk
Copy link
Contributor

I won't be able this week, will try get to it next one. You can take a shot at it if you want.

I am on parental leave in November as my second son was born on Monday. I will have really limited presence here in the next 3-4 weeks. If you won't have time for this during November then I will give it a try in December.

Congrats Peter and enjoy your parental leave! :) I'll try get to it if possible.

@peter-csala
Copy link
Contributor Author

I won't be able this week, will try get to it next one. You can take a shot at it if you want.

I am on parental leave in November as my second son was born on Monday. I will have really limited presence here in the next 3-4 weeks. If you won't have time for this during November then I will give it a try in December.

Congrats Peter and enjoy your parental leave! :) I'll try get to it if possible.

@martintmk Am I right that you did not have time to file a PR regarding ☝🏻 ?

@martintmk
Copy link
Contributor

I won't be able this week, will try get to it next one. You can take a shot at it if you want.

I am on parental leave in November as my second son was born on Monday. I will have really limited presence here in the next 3-4 weeks. If you won't have time for this during November then I will give it a try in December.

Congrats Peter and enjoy your parental leave! :) I'll try get to it if possible.

@martintmk Am I right that you did not have time to file a PR regarding ☝🏻 ?

Sadly, not really. Haven't had time recently.

@peter-csala
Copy link
Contributor Author

Sadly, not really. Haven't had time recently.

No worries, I'll take care of it.🤘

@peter-csala peter-csala mentioned this pull request Dec 8, 2023
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants