Skip to content

Commit

Permalink
Release v8 docs (#1599)
Browse files Browse the repository at this point in the history
  • Loading branch information
martintmk authored Sep 27, 2023
1 parent 32aa4bc commit 1296756
Show file tree
Hide file tree
Showing 8 changed files with 313 additions and 1,400 deletions.
1,257 changes: 312 additions & 945 deletions README.md

Large diffs are not rendered by default.

439 changes: 0 additions & 439 deletions README_V8.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/advanced/resilience-context.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
# Resilience context

> [!NOTE]
> This is documentation for the upcoming Polly v8 release.
The `ResilienceContext` class in Polly provides an execution-scoped instance that accompanies each execution through a Polly resilience strategy. This class serves to share context and facilitate information exchange between the pre-execution, mid-execution, and post-execution phases.

The resilience context exposes several properties:
Expand Down
3 changes: 0 additions & 3 deletions docs/general.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
# General

> [!NOTE]
> This is documentation for the upcoming Polly v8 release.
## Supported targets

Polly targets .NET Standard 2.0+ ([coverage](https://docs.microsoft.com/dotnet/standard/net-standard#net-implementation-support): .NET Core 2.0+, .NET Core 3.0, .NET 6.0+ and later Mono, Xamarin and UWP targets). The NuGet package also includes direct targets for .NET Framework 4.6.1 and 4.7.2.
Expand Down
3 changes: 0 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
# Meet Polly: The .NET resilience library

> [!NOTE]
> This is documentation for the upcoming Polly v8 release.
![Polly logo](https://raw.github.com/App-vNext/Polly/main/Polly-Logo.png)

Polly is a powerful library for .NET that helps you handle transient faults and improve the resilience of your applications. With Polly, you can easily define and apply strategies such as Retry, Circuit Breaker, Hedging, Timeout, Rate Limiter and Fallback to handle failures and slowdowns in a fluent and thread-safe way.
Expand Down
3 changes: 0 additions & 3 deletions docs/pipelines/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
# Resilience pipelines

> [!NOTE]
> This is documentation for the upcoming Polly v8 release.
The `ResiliencePipeline` allows executing arbitrary user-provided callbacks. It is a combination of one or more resilience strategies.

## Usage
Expand Down
3 changes: 0 additions & 3 deletions docs/strategies/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
# Resilience strategies

> [!NOTE]
> This is documentation for the upcoming Polly v8 release.
Resilience strategies are essential components of Polly, designed to execute user-defined callbacks while adding an extra layer of resilience. These strategies can't be executed directly; they must be run through a **resilience pipeline**. Polly provides an API to construct resilience pipelines by incorporating one or more resilience strategies through the pipeline builders.

Polly categorizes resilience strategies into two main groups:
Expand Down
2 changes: 1 addition & 1 deletion package-readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ Polly is a .NET resilience and transient-fault-handling library that allows deve

## Documentation and Samples

Documentation, and samples, for using Polly can be found in the repository's [README](https://github.com/App-vNext/Polly#readme) and [wiki](https://github.com/App-vNext/Polly/wiki).
Documentation, and samples, for using Polly can be found in the repository's [README](https://github.com/App-vNext/Polly#readme) and [documentation](https://www.pollydocs.org/).

0 comments on commit 1296756

Please sign in to comment.