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] Fix pollydocs menu #2136

Merged
merged 1 commit into from
May 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/advanced/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
- name: Telemetry
href: telemetry.md
- name: Dependency injection
href: dependency-injection.md
- name: Resilience context
href: resilience-context.md
- name: Performance
href: performance.md
- name: Testing
href: testing.md
- name: Use with F# and Visual Basic
href: use-with-fsharp-and-visual-basic.md
10 changes: 10 additions & 0 deletions docs/chaos/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
- name: Chaos engineering
href: index.md
- name: Fault
href: fault.md
- name: Outcome
href: outcome.md
- name: Latency
href: latency.md
- name: Behavior
href: behavior.md
10 changes: 10 additions & 0 deletions docs/community/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
- name: Polly-Contrib projects and libraries
href: polly-contrib.md
- name: Libraries and contributions
href: libraries-and-contributions.md
- name: Useful resources and links
href: resources.md
- name: Git workflow
href: git-workflow.md
- name: Cheat sheets
href: cheat-sheets.md
6 changes: 6 additions & 0 deletions docs/extensibility/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
- name: Extensibility
href: index.md
- name: Proactive strategy
href: proactive-strategy.md
- name: Reactive strategy
href: reactive-strategy.md
2 changes: 1 addition & 1 deletion docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ await pipeline.ExecuteAsync(static async token => { /* Your custom logic goes he

> [!NOTE]
> Asynchronous methods in the Polly API return `ValueTask` or `ValueTask<T>` instead of `Task` or `Task<T>`.
> If you are using Polly in Visual Basic or F#, please read [Use with F# and Visual Basic](use-with-fsharp-and-visual-basic.md) for more information.
> If you are using Polly in Visual Basic or F#, please read [Use with F# and Visual Basic](advanced/use-with-fsharp-and-visual-basic.md) for more information.

## Dependency injection

Expand Down
4 changes: 4 additions & 0 deletions docs/pipelines/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
- name: Resilience pipelines
href: index.md
- name: Resilience pipeline registry
href: resilience-pipeline-registry.md
14 changes: 14 additions & 0 deletions docs/strategies/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
- name: Resilience strategies
href: index.md
- name: Timeout
href: timeout.md
- name: Retry
href: retry.md
- name: Rate limiter
href: rate-limiter.md
- name: Hedging
href: hedging.md
- name: Fallback
href: fallback.md
- name: Circuit breaker
href: circuit-breaker.md
70 changes: 6 additions & 64 deletions docs/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,80 +8,22 @@
href: migration-v8.md

- name: Resilience strategies
href: strategies/index.md
expanded: true
items:
- name: Timeout
href: strategies/timeout.md
- name: Retry
href: strategies/retry.md
- name: Rate limiter
href: strategies/rate-limiter.md
- name: Hedging
href: strategies/hedging.md
- name: Fallback
href: strategies/fallback.md
- name: Circuit breaker
href: strategies/circuit-breaker.md
href: strategies/

- name: Resilience pipelines
href: pipelines/index.md
expanded: true
items:
- name: Resilience pipeline registry
href: pipelines/resilience-pipeline-registry.md
href: pipelines/

- name: Chaos engineering
href: chaos/index.md
expanded: true
items:
- name: Fault
href: chaos/fault.md
- name: Outcome
href: chaos/outcome.md
- name: Latency
href: chaos/latency.md
- name: Behavior
href: chaos/behavior.md
href: chaos/

- name: Advanced topics
expanded: true
items:
- name: Telemetry
href: advanced/telemetry.md
- name: Dependency injection
href: advanced/dependency-injection.md
- name: Resilience context
href: advanced/resilience-context.md
- name: Performance
href: advanced/performance.md
- name: Testing
href: advanced/testing.md
- name: Use with F# and Visual Basic
href: use-with-fsharp-and-visual-basic.md
href: advanced/

- name: Extensibility
href: extensibility/index.md
expanded: true
items:
- name: Proactive strategy
href: extensibility/proactive-strategy.md
- name: Reactive strategy
href: extensibility/reactive-strategy.md
href: extensibility/

- name: Community and resources
expanded: true
items:
- name: Polly-Contrib projects and libraries
href: community/polly-contrib.md
- name: Libraries and contributions
href: community/libraries-and-contributions.md
- name: Useful resources and links
href: community/resources.md
- name: Git workflow
href: community/git-workflow.md
- name: Cheat sheets
href: community/cheat-sheets.md
href: community/

- name: API
href: api/
Loading