Skip to content

Commit

Permalink
Docs tweaks (#1655)
Browse files Browse the repository at this point in the history
- Fix CS7035 warning from docfx by cloning with the tags to compute the version number correctly.
- Fix two small typos.
- Remove outdated notes from content.
- Add Polly as the name and title for the site.
- Specify the language as English.
  • Loading branch information
martincostello authored Sep 29, 2023
1 parent 5634c30 commit e21aec3
Show file tree
Hide file tree
Showing 9 changed files with 24 additions and 32 deletions.
2 changes: 1 addition & 1 deletion docs/community/polly-contrib.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Polly now has a [Polly-Contrib](https://github.com/Polly-Contrib) to allow the community to contribute policies or other enhancements around Polly with a low burden of ceremony.

Have a contrib you'd like to publish under Polly-Contrib? Contact us with an issue here or on [Polly's slack](http://pollytalk.slack.com), and we can set up a CI-ready Polly.Contrib repo to which you have full rights, to help you manage and deliver your awesomeness to the community!
Have a contrib you'd like to publish under Polly-Contrib? Contact us with an issue here or on [Polly's Slack](http://pollytalk.slack.com), and we can set up a CI-ready Polly.Contrib repo to which you have full rights, to help you manage and deliver your awesomeness to the community!

We also provide:

Expand Down
5 changes: 4 additions & 1 deletion docs/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,11 @@
],
"build": {
"globalMetadata": {
"_appName": "Polly",
"_appTitle": "Polly",
"_appLogoPath": "icon.png",
"_appFaviconPath": "icon.png"
"_appFaviconPath": "icon.png",
"_lang": "en"
},
"content": [
{
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Getting started

To use Polly, you must provide a callback and execute it using [**resilience pipeline**](pipelines/index.md). A resilience pipeline is a combination of one or more [**resilience strategies**](strategies/index.md) such as retry, timeout, and rate limiter. Polly uses **builders** to integrate these strategies into a pipeline.
To use Polly, you must provide a callback and execute it using a [**resilience pipeline**](pipelines/index.md). A resilience pipeline is a combination of one or more [**resilience strategies**](strategies/index.md) such as retry, timeout, and rate limiter. Polly uses **builders** to integrate these strategies into a pipeline.

To get started, first add the [Polly.Core](https://www.nuget.org/packages/Polly.Core/) package to your project by running the following command:

Expand Down
3 changes: 0 additions & 3 deletions docs/strategies/circuit-breaker.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,6 @@

---

> [!NOTE]
> Version 8 documentation for this strategy has not yet been migrated. For more information on circuit breaker concepts and behavior, refer to the [older documentation](https://github.com/App-vNext/Polly/wiki/Circuit-Breaker).
> [!NOTE]
> Be aware that the Circuit Breaker strategy [rethrows all exceptions](https://github.com/App-vNext/Polly/wiki/Circuit-Breaker#exception-handling), including those that are handled. A Circuit Breaker's role is to monitor faults and break the circuit when a certain threshold is reached; it does not manage retries. Combine the Circuit Breaker with a Retry strategy if needed.
Expand Down
3 changes: 0 additions & 3 deletions docs/strategies/fallback.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,6 @@

---

> [!NOTE]
> Version 8 documentation for this strategy has not yet been migrated. For more information on fallback concepts and behavior, refer to the [older documentation](https://github.com/App-vNext/Polly/wiki/Fallback).
## Usage

<!-- snippet: fallback -->
Expand Down
3 changes: 0 additions & 3 deletions docs/strategies/retry.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,6 @@

---

> [!NOTE]
> Version 8 documentation for this strategy has not yet been migrated. For more information on retry concepts and behavior, refer to the [older documentation](https://github.com/App-vNext/Polly/wiki/Retry).
## Usage

<!-- snippet: Retry -->
Expand Down
3 changes: 0 additions & 3 deletions docs/strategies/timeout.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,6 @@

---

> [!NOTE]
> Version 8 documentation for this strategy has not yet been migrated. For more information on timeout concepts and behavior, refer to the [older documentation](https://github.com/App-vNext/Polly/wiki/Timeout).
## Usage

<!-- snippet: timeout -->
Expand Down
18 changes: 18 additions & 0 deletions eng/Common.targets
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,22 @@
<ItemGroup Condition="'$(LegacySupport)' == 'true' AND !$([MSBuild]::IsTargetFrameworkCompatible($(TargetFramework), 'netcoreapp3.1'))">
<Compile Include="$(MSBuildThisFileDirectory)..\src\LegacySupport\*.cs" LinkBase="LegacySupport" />
</ItemGroup>

<ItemGroup Label="MinVer">
<PackageReference Include="MinVer" PrivateAssets="All" />
</ItemGroup>

<PropertyGroup Label="MinVer">
<MinVerMinimumMajorMinor>8.0</MinVerMinimumMajorMinor>
</PropertyGroup>

<Target Name="CustomizeVersions" AfterTargets="MinVer" Condition="'$(GITHUB_ACTIONS)' == 'true'">
<PropertyGroup>
<FileVersion>$([MSBuild]::ValueOrDefault('$(MinVerMajor)', '8')).$([MSBuild]::ValueOrDefault('$(MinVerMinor)', '0')).$([MSBuild]::ValueOrDefault('$(MinVerPatch)', '0')).$(GITHUB_RUN_NUMBER)</FileVersion>
</PropertyGroup>
<PropertyGroup Condition="$(GITHUB_REF.StartsWith(`refs/pull/`))">
<PackageVersion>$(MinVerMajor).$(MinVerMinor).$(MinVerPatch)-pr.$(GITHUB_REF_NAME.Replace(`/merge`, ``)).$(GITHUB_RUN_NUMBER)</PackageVersion>
</PropertyGroup>
</Target>

</Project>
17 changes: 0 additions & 17 deletions eng/Library.targets
Original file line number Diff line number Diff line change
Expand Up @@ -57,23 +57,6 @@
</ItemGroup>
</Target>

<ItemGroup Label="MinVer">
<PackageReference Include="MinVer" PrivateAssets="All" />
</ItemGroup>

<PropertyGroup Label="MinVer">
<MinVerMinimumMajorMinor>8.0</MinVerMinimumMajorMinor>
</PropertyGroup>

<Target Name="CustomizeVersions" AfterTargets="MinVer" Condition="'$(GITHUB_ACTIONS)' == 'true'">
<PropertyGroup>
<FileVersion>$(MinVerMajor).$(MinVerMinor).$(MinVerPatch).$(GITHUB_RUN_NUMBER)</FileVersion>
</PropertyGroup>
<PropertyGroup Condition="$(GITHUB_REF.StartsWith(`refs/pull/`))">
<PackageVersion>$(MinVerMajor).$(MinVerMinor).$(MinVerPatch)-pr.$(GITHUB_REF_NAME.Replace(`/merge`, ``)).$(GITHUB_RUN_NUMBER)</PackageVersion>
</PropertyGroup>
</Target>

<ItemGroup Condition="$(UsePublicApiAnalyzers) != 'false'">
<PackageReference Include="Microsoft.CodeAnalysis.PublicApiAnalyzers">
<PrivateAssets>all</PrivateAssets>
Expand Down

0 comments on commit e21aec3

Please sign in to comment.