MVP .NET referential feature & inter-tech how-to documentation #2769

flossypurse · 2024-04-22T21:06:24Z

No description provided.

docs/develop/dotnet/child-workflows.mdx

docs/develop/dotnet/cancellation.mdx

cretz · 2024-05-01T13:43:18Z

docs/develop/dotnet/cancellation.mdx

+##### Cancel
+
+Canceling a Workflow provides a graceful way to stop Workflow Execution.


This section and what's expected to go in it is unclear to me

cretz · 2024-05-01T13:44:50Z

docs/develop/dotnet/data-encryption.mdx

+## Payload conversion
+
+<!-- CONTENT-->
+
+### Conversion sequence {#conversion-sequence}
+
+<!-- CONTENT-->
+
+### Custom Payload Converter {#custom-payload-converter}
+
+**How to use a custom Payload Converter with the .NET SDK.**
+
+<!-- CONTENT-->
+
+**List of default Data Converter supports converting multiple types**
+
+<!-- CONTENT-->
+
+### Custom Type Data Conversion
+
+<!-- CONTENT-->


Only the payload codec is related to encryption, none of the other sections are related to encryption in any way and are used by users for type conversion customization, not encryption.

cretz · 2024-05-01T13:46:35Z

docs/develop/dotnet/cancellation.mdx

+
+## Request Cancellation {#request-cancellation}
+
+**How to request Cancellation of a Workflow and Activities in Go.**


Requesting cancellation of a workflow is a different concept than requesting cancellation of an activity, so I am splitting these

cretz · 2024-05-01T14:03:33Z

docs/develop/dotnet/cancellation.mdx

+
+<!-- CONTENT-->
+
+### How to terminate a Workflow Execution in .NET {#terminate-a-workflow-execution}


The heading depth is a bit confusing here

cretz · 2024-05-01T14:09:17Z

docs/develop/dotnet/cancellation.mdx

+
+Canceling a Workflow provides a graceful way to stop Workflow Execution.
+
+##### Terminate


This file and entire section is "How to cancel a Workflow Execution and it's (sic) Activities using the .NET SDK.". Termination shouldn't be buried in cancellation documentation.

fairlydurable · 2024-05-01T14:11:12Z

docs/develop/dotnet/cancellation.mdx

+  - overview
+---
+
+This pages shows the following:


Suggested change

This pages shows the following:

This page shows the following:

fairlydurable · 2024-05-01T14:12:47Z

docs/develop/dotnet/cancellation.mdx

+id: cancellation
+title: Cancellation - .NET SDK feature guide
+sidebar_label: Cancellation
+description: How to cancel a Workflow Execution and it's Activities using the .NET SDK.


Suggested change

description: How to cancel a Workflow Execution and it's Activities using the .NET SDK.

description: How to cancel a Workflow Execution and its Activities using the .NET SDK.

fairlydurable · 2024-05-01T14:13:35Z

docs/develop/dotnet/temporal-client.mdx

+
+<!-- CONTENT-->
+
+## Start a Workflow {#start-worklow}


Suggested change

## Start a Workflow {#start-worklow}

## Start a Workflow {#start-workflow}

cretz · 2024-05-01T14:27:53Z

docs/develop/dotnet/continue-as-new.mdx

@@ -0,0 +1,19 @@
+---
+id: continue-as-new
+title: How to Continue-As-New in Dotnet


Suggested change

title: How to Continue-As-New in Dotnet

title: How to Continue-As-New in .NET

Inconsistent

cretz · 2024-05-01T14:28:18Z

docs/develop/dotnet/data-encryption.mdx

+title: Date Encryption
+sidebar_label: Date encryption
+description: Date encryption


Misspelled "Data"

cretz · 2024-05-01T14:33:11Z

docs/develop/dotnet/child-workflows.mdx

@@ -0,0 +1,24 @@
+---
+id: child-workflows
+title: Child Workflows in .NET


Inconsistent with whether you suffix titles with " - .NET SDK feature guide"

cretz · 2024-05-01T19:24:35Z

docs/develop/dotnet/durable-timers.mdx

+
+<!-- CONTENT-->
+
+## Skip time in tests {#testing-skip-time}


I don't think this should be here, I think it should be with the testing documentation. It's not about durable timers a user may create, it's also about timeouts and other things.

cretz · 2024-05-01T19:31:04Z

docs/develop/dotnet/failure-detection.mdx

+  - failure-detection
+---
+
+## Failure Detection {#failure-detection}


What is expected to be put under this heading? The next heading is not a child. Is there existing SDK documentation you can point to as a guide so we can be consistent here?

cretz · 2024-05-01T19:31:58Z

docs/develop/dotnet/failure-detection.mdx

+
+## Failure Detection {#failure-detection}
+
+## Workflow timeouts {#workflow-timeouts}


The title of this document is failure detection but we often don't consider timeouts the same as failures. Also, not sure these general purpose options are about failure detections. I think they deserve to be next to other workflow options.

cretz · 2024-05-01T20:16:10Z

docs/develop/dotnet/cancellation.mdx

+
+<!-- CONTENT-->
+
+### How to terminate a Workflow Execution in .NET {#terminate-a-workflow-execution}


The "in .NET" suffix is a bit inconsistent here with other headings

cretz · 2024-05-01T20:16:22Z

docs/develop/dotnet/heartbeats.mdx

+  - heartbeat-timeout
+---
+
+## How to Heartbeat an Activity {#Activity-heartbeats}


Inconsistent anchor capitalization

cretz · 2024-05-01T20:17:20Z

docs/develop/dotnet/message-passing.mdx

@@ -0,0 +1,109 @@
+---
+id: message-passing
+title: Application message passing - .NET SDK feature guide


"Workflow interaction" I think is a better name for these concepts than "Application message passing"

cretz · 2024-05-01T20:18:20Z

docs/develop/dotnet/heartbeats.mdx

@@ -0,0 +1,26 @@
+---
+id: heartbeat


ID inconsistent with file name

cretz · 2024-05-01T20:22:08Z

docs/develop/dotnet/cancellation.mdx

+
+<!-- CONTENT-->
+
+## How to interrupt a Workflow Execution {#interrupt-a-workflow-execution}


We are inconsistent with whether we put "How to" in the heading title (e.g. it's "Request Cancellation" not "How to request Cancellation")

cretz · 2024-05-01T20:34:53Z

Note, work on the .NET docs has already started off the current branch, so any changes to this branch may not be reflected. Instead, take the review comments as changes that need to be made when cleaning up the submitted .NET docs.

cretz · 2024-05-01T20:35:43Z

docs/develop/dotnet/data-encryption.mdx

+
+<!-- CONTENT-->
+
+### Custom Type Data Conversion


Suggested change

### Custom Type Data Conversion

### Custom type Data Conversion

Unsure if "Type" should be capitalized in this case

cretz · 2024-05-01T20:35:59Z

docs/develop/dotnet/data-encryption.mdx

+
+<!-- CONTENT-->
+
+## Payload conversion


Conversion not capitalized here but it is with Data Conversion below

cretz · 2024-05-01T20:36:39Z

docs/develop/dotnet/failure-detection.mdx

+
+<!-- CONTENT-->
+
+## How to set Activity timeouts {#activity-timeouts}


Inconsistent headings with workflow timeouts (this is prefixed with "How to set" but "Workflow timeouts" section is not)

cretz · 2024-05-01T20:42:51Z

docs/develop/dotnet/index.mdx

+  - feature guidance
+---
+
+<!-- .NET SDK feature guidance landing page-->


This is the first ever feature guidance landing page, so unsure what to add here. I am assuming I follow the dev-guide landing pages?

cretz · 2024-05-01T20:44:49Z

docs/develop/dotnet/message-passing.mdx

+  - updates
+---
+
+<!-- What is on this page-->


Inconsistent with whether you provide this or expect it to be provided. I would expect this could have already been filled in the way it is in some other pages.

cretz · 2024-05-02T12:49:31Z

docs/develop/dotnet/observability.mdx

+**List of metrics capable of being emitted**
+
+<!-- CONTENT-->


This appears to be brand new for .NET. I don't think .NET is where we should introduce this new bold heading, it should be done consistently.

cretz · 2024-05-02T13:44:06Z

docs/develop/dotnet/observability.mdx

+
+<!-- CONTENT-->
+
+### How to remove a Search Attribute from a Workflow {#remove-search-attribute}


This section is not needed, upsert includes removal

cretz · 2024-05-02T13:44:42Z

docs/develop/dotnet/observability.mdx

+
+### How to upsert Search Attributes {#upsert-search-attributes}
+
+**How to upsert Search Attributes to add or update Search Attributes from within Workflow code**


This is the same as the next part, there's no difference between the two

cretz · 2024-05-02T13:51:08Z

docs/develop/dotnet/schedules.mdx

+  - dotnet
+  - schedules
+---
+


We are inconsistent with whether the top of the page has a summary of what's on the page

cretz · 2024-05-02T17:20:18Z

docs/develop/dotnet/schedules.mdx

+
+<!-- CONTENT-->
+
+## How to use Temporal Cron Jobs {#temporal-cron-jobs}


I think this section should be removed

cretz · 2024-05-03T13:05:51Z

docs/develop/dotnet/versioning.mdx

+## How to use Worker Versioning in .NET {#worker-versioning}
+
+<!-- CONTENT-->
+
+### Assign a Build ID to your Worker
+
+<!-- CONTENT-->
+
+### Specify versions for Commands
+
+**How to specify versioning intent**
+
+<!-- CONTENT-->
+
+**How to use the latest default version of an Activity**
+
+<!-- CONTENT-->


I don't believe these sections should be added at this time knowing they are already obsolete pending new versioning implementation

cretz · 2024-05-03T13:08:04Z

docs/develop/dotnet/versioning.mdx

+
+## Introduction to Versioning
+
+## How to use the .NET SDK Patching API {#.NET-sdk-patching-api}


Inconsistent use of the runtime name in the anchor

Co-authored-by: Cully Wakelin <cully@temporal.io>

scaffolding .net pages

dc162fb

flossypurse requested a review from a team as a code owner April 22, 2024 21:06

flossypurse marked this pull request as draft April 22, 2024 21:06

vercel bot deployed to Preview April 22, 2024 21:06 View deployment

flossypurse changed the title ~~Scaffolding .net pages~~ Scaffolding .NET SDK pages Apr 22, 2024

adding additional pages to guide

cbb444e

vercel bot deployed to Preview April 26, 2024 15:20 View deployment

add keywords

b986d77

vercel bot deployed to Preview April 26, 2024 16:38 View deployment

flossypurse commented Apr 29, 2024

View reviewed changes

docs/develop/dotnet/child-workflows.mdx Outdated Show resolved Hide resolved

updating with new pages

6c10209

vercel bot deployed to Preview April 30, 2024 12:57 View deployment

updating ordering and removing

3044eab

vercel bot deployed to Preview April 30, 2024 14:36 View deployment

cretz reviewed May 1, 2024

View reviewed changes

docs/develop/dotnet/cancellation.mdx Outdated Show resolved Hide resolved

cretz reviewed May 1, 2024

View reviewed changes

removing Go references

917d528

vercel bot deployed to Preview May 1, 2024 13:53 View deployment

cretz reviewed May 1, 2024

View reviewed changes

fairlydurable reviewed May 1, 2024

View reviewed changes

cretz reviewed May 1, 2024

View reviewed changes

docs/develop/dotnet/heartbeats.mdx

@@ -0,0 +1,26 @@

---

id: heartbeat

Copy link

Member

cretz May 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ID inconsistent with file name

cretz reviewed May 1, 2024

View reviewed changes

cretz reviewed May 2, 2024

View reviewed changes

cretz reviewed May 3, 2024

View reviewed changes

cretz mentioned this pull request May 3, 2024

.NET docs #2799

Merged

.NET docs (#2799)

9d1d846

Co-authored-by: Cully Wakelin <cully@temporal.io>

vercel bot deployed to Preview May 6, 2024 17:49 View deployment

flossypurse marked this pull request as ready for review May 6, 2024 17:50

flossypurse changed the title ~~Scaffolding .NET SDK pages~~ .MVP NET referential feature & inter-tech how-to documentation May 8, 2024

flossypurse changed the title ~~.MVP NET referential feature & inter-tech how-to documentation~~ MVP .NET referential feature & inter-tech how-to documentation May 9, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MVP .NET referential feature & inter-tech how-to documentation #2769

MVP .NET referential feature & inter-tech how-to documentation #2769

flossypurse commented Apr 22, 2024

cretz May 1, 2024

cretz May 1, 2024 •

edited

cretz May 1, 2024

cretz May 1, 2024

cretz May 1, 2024 •

edited

fairlydurable May 1, 2024

fairlydurable May 1, 2024

fairlydurable May 1, 2024

cretz May 1, 2024

cretz May 1, 2024 •

edited

cretz May 1, 2024

cretz May 1, 2024 •

edited

cretz May 1, 2024 •

edited

cretz May 1, 2024 •

edited

cretz May 1, 2024

cretz May 1, 2024

cretz May 1, 2024

cretz May 1, 2024

cretz May 1, 2024

cretz commented May 1, 2024

cretz May 1, 2024

cretz May 1, 2024

cretz May 1, 2024

cretz May 1, 2024

cretz May 1, 2024

cretz May 2, 2024

cretz May 2, 2024

cretz May 2, 2024

cretz May 2, 2024

cretz May 2, 2024

cretz May 3, 2024

cretz May 3, 2024

		##### Cancel

		Canceling a Workflow provides a graceful way to stop Workflow Execution.


		## Request Cancellation {#request-cancellation}

		How to request Cancellation of a Workflow and Activities in Go.


		<!-- CONTENT-->

		### How to terminate a Workflow Execution in .NET {#terminate-a-workflow-execution}


		Canceling a Workflow provides a graceful way to stop Workflow Execution.

		##### Terminate

	This pages shows the following:
	This page shows the following:

	description: How to cancel a Workflow Execution and it's Activities using the .NET SDK.
	description: How to cancel a Workflow Execution and its Activities using the .NET SDK.

	## Start a Workflow {#start-worklow}
	## Start a Workflow {#start-workflow}

	title: How to Continue-As-New in Dotnet
	title: How to Continue-As-New in .NET


		## Failure Detection {#failure-detection}

		## Workflow timeouts {#workflow-timeouts}


		<!-- CONTENT-->

		## How to interrupt a Workflow Execution {#interrupt-a-workflow-execution}

	### Custom Type Data Conversion
	### Custom type Data Conversion


		<!-- CONTENT-->

		## How to set Activity timeouts {#activity-timeouts}


		<!-- CONTENT-->

		### How to remove a Search Attribute from a Workflow {#remove-search-attribute}


		### How to upsert Search Attributes {#upsert-search-attributes}

		How to upsert Search Attributes to add or update Search Attributes from within Workflow code


		<!-- CONTENT-->

		## How to use Temporal Cron Jobs {#temporal-cron-jobs}


		## Introduction to Versioning

		## How to use the .NET SDK Patching API {#.NET-sdk-patching-api}

MVP .NET referential feature & inter-tech how-to documentation #2769

Are you sure you want to change the base?

MVP .NET referential feature & inter-tech how-to documentation #2769

Conversation

flossypurse commented Apr 22, 2024

Choose a reason for hiding this comment

cretz May 1, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cretz May 1, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cretz May 1, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cretz May 1, 2024 • edited

Choose a reason for hiding this comment

cretz May 1, 2024 • edited

Choose a reason for hiding this comment

cretz May 1, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cretz commented May 1, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cretz May 1, 2024 •

edited

cretz May 1, 2024 •

edited

cretz May 1, 2024 •

edited

cretz May 1, 2024 •

edited

cretz May 1, 2024 •

edited

cretz May 1, 2024 •

edited