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

overhaul dev guide indices, titles, tags #3088

Merged
merged 12 commits into from
Oct 1, 2024
8 changes: 5 additions & 3 deletions docs/develop/dotnet/asynchronous-activity.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: asynchronous-activity
title: Asynchronous Activity - .NET SDK feature guide
sidebar_label: Asynchronous Activity
title: Asynchronous Activity completion - .NET SDK
sidebar_label: Asynchronous Activity completion
description: Learn how to asynchronously complete an Activity in Temporal. Follow simple steps to allow an Activity Function to return without the Activity Execution completing.
toc_max_heading_level: 4
keywords:
Expand All @@ -23,8 +23,10 @@ keywords:
- getasyncactivityhandle
tags:
- asynchronous-activity
- dotnet-sdk
- overview
- sdk
- dotnet-sdk
- developer guide
---

This page describes how to asynchronously complete an Activity.
Expand Down
18 changes: 10 additions & 8 deletions docs/develop/dotnet/cancellation.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: cancellation
title: Interrupt a Workflow - .NET SDK feature guide
title: Interrupt a Workflow - .NET SDK
sidebar_label: Interrupt a Workflow
description: Learn how to interrupt Workflow Execution in .NET using the Temporal SDK. Cancel for graceful stops; terminate for forceful stops. Handle Cancellation in Workflow and Activities efficiently.
toc_max_heading_level: 4
Expand Down Expand Up @@ -28,8 +28,9 @@ keywords:
- workflow code examples
tags:
- cancellation
- sdk
- dotnet-sdk
- overview
- developer guide
---

This page shows how to interrupt a Workflow Execution.
Expand All @@ -38,12 +39,13 @@ You can interrupt a Workflow Execution in one of the following ways:

- [Cancel](#cancellation): Canceling a Workflow provides a graceful way to stop Workflow Execution.
- [Terminate](#termination): Terminating a Workflow forcefully stops Workflow Execution.
Terminating a Workflow forcefully stops Workflow Execution.
This action resembles killing a process.
- The system records a `WorkflowExecutionTerminated` event in the Workflow History.
- The termination forcefully and immediately stops the Workflow Execution.
- The Workflow code gets no chance to handle termination.
- A Workflow Task doesn't get scheduled.

Terminating a Workflow forcefully stops Workflow Execution.
This action resembles killing a process.
- The system records a `WorkflowExecutionTerminated` event in the Workflow History.
- The termination forcefully and immediately stops the Workflow Execution.
- The Workflow code gets no chance to handle termination.
- A Workflow Task doesn't get scheduled.

In most cases, canceling is preferable because it allows the Workflow to finish gracefully.
Terminate only if the Workflow is stuck and cannot be canceled normally.
Expand Down
6 changes: 3 additions & 3 deletions docs/develop/dotnet/child-workflows.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: child-workflows
title: Child Workflows - .NET SDK feature guide
title: Child Workflows - .NET SDK
sidebar_label: Child Workflows
description: Learn how to start a Child Workflow Execution and set a Parent Close Policy using Temporal .NET SDK. Discover methods like ExecuteChildWorkflowAsync and manage Workflow behaviors.
keywords:
Expand All @@ -23,9 +23,9 @@ keywords:
- parentclosepolicy
- child workflow in .net
tags:
- developer-guide
- sdk
- dotnet
- dotnet-sdk
- developer guide
- child-workflow
---

Expand Down
5 changes: 3 additions & 2 deletions docs/develop/dotnet/continue-as-new.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: continue-as-new
title: Continue-As-New - .NET SDK feature guide
title: Continue-As-New - .NET SDK
sidebar_label: Continue-As-New
description: Learn how to use Continue-As-New with the Temporal .NET SDK to manage Workflow Event Histories, ensuring optimal performance by starting new Executions seamlessly.
keywords:
Expand All @@ -9,7 +9,8 @@ keywords:
- continue-as-new
tags:
- sdk
- dotnet
- developer guide
- dotnet-sdk
- continue-as-new
---

Expand Down
7 changes: 4 additions & 3 deletions docs/develop/dotnet/core-application.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: core-application
title: Core application - .NET SDK feature guide
title: Core application - .NET SDK
sidebar_label: Core application
description: Learn how to develop a basic Workflow and Activity Definition using the Temporal .NET SDK, run a Worker Process, and set up Dynamic Workflows and Activities.
toc_max_heading_level: 4
Expand All @@ -20,13 +20,14 @@ tags:
- activity-definition
- activity-execution
- code-samples
- dotnet
- dotnet-sdk
- worker
- workflow
- workflow-execution
- workflow-parameters
- workflow-return-values
- sdk
- dotnet-sdk
- developer guide
---

This page shows how to do the following:
Expand Down
5 changes: 3 additions & 2 deletions docs/develop/dotnet/data-encryption.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: data-encryption
title: Data encryption - .NET SDK feature guide
title: Data encryption - .NET SDK
sidebar_label: Data encryption
description: Learn how to use a custom Payload Codec and Converter in the .NET SDK to modify Temporal Data Conversion behavior, including examples for encryption and camel case conversion.
keywords:
Expand All @@ -11,7 +11,8 @@ keywords:
- converter
tags:
- sdk
- dotnet
- dotnet-sdk
- developer guide
- data encryption
- codec server
- converter
Expand Down
5 changes: 3 additions & 2 deletions docs/develop/dotnet/debugging.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: debugging
title: Debugging - .NET SDK feature guide
title: Debugging - .NET SDK
sidebar_label: Debugging
description: Learn how to debug Workflows in development and production environments using Temporal .NET SDK. Utilize logging, debugger, Web UI, CLI, replay, tracing, and more for efficient troubleshooting.
toc_max_heading_level: 4
Expand All @@ -10,7 +10,8 @@ keywords:
- debugging
tags:
- sdk
- dotnet
- dotnet-sdk
- developer guide
- debugging
---

Expand Down
5 changes: 3 additions & 2 deletions docs/develop/dotnet/durable-timers.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: durable-timers
title: Durable Timers - .NET SDK feature guide
title: Durable Timers - .NET SDK
description: Learn how to set a Durable Timer using the Temporal .NET SDK. Pause Workflow execution for days or months. Timers are persisted and highly resource-efficient using Workflow.DelayAsync.
sidebar_label: Durable Timers
keywords:
Expand All @@ -11,7 +11,8 @@ keywords:
- time-skipping
tags:
- sdk
- dotnet
- dotnet-sdk
- developer guide
- durable-timers
- sleep
- time-skipping
Expand Down
7 changes: 3 additions & 4 deletions docs/develop/dotnet/failure-detection.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: failure-detection
title: Failure detection - .NET SDK feature guide
title: Failure detection - .NET SDK
sidebar_label: Failure detection
description: Learn how to set Workflow and Activity Timeouts, implement Retry Policies, and manage Activity Heartbeats using the Temporal .NET SDK for efficient Workflow Execution.
toc_max_heading_level: 4
Expand All @@ -11,10 +11,9 @@ keywords:
- sdk
- failure detection
tags:
- guide-context
- how-to
- dotnet
- sdk
- dotnet-sdk
- developer guide
- failure-detection
---

Expand Down
Loading