Go Feature Guide: Editing #2904

jsundai · 2024-06-06T13:48:03Z

What does this PR do?

Aligning the feature guides (i.e - format, headings, etc)

Notes to reviewers

angelazhou32 · 2024-08-01T20:12:22Z

docs/develop/go/core-application.mdx

@@ -370,7 +232,9 @@ func YourWorkflowDefinition(ctx workflow.Context, param YourWorkflowParam) (*You
 }
 ```

-### How to customize Workflow Type in Go {#customize-workflow-type}
+### Customize Workflow Type in Go {#customize-workflow-type}


You replaced "in Go" with "using the Go SDK" above so maybe you can replace this with 'using the Go SDK' as well

+1 to Angela, who got there before me.

Also maybe Types instead of Type

angelazhou32 · 2024-08-01T20:12:38Z

docs/develop/go/core-application.mdx

@@ -437,7 +303,9 @@ The Temporal Go SDK has APIs to handle equivalent Go constructs:
 - `workflow.Context` This is a replacement for `context.Context`.
  See [Tracing](/develop/go/observability#tracing-and-context-propogation) for more information about context propagation.

-## How to develop an Activity Definition in Go {#activity-definition}
+## Develop an Activity Definition in Go {#activity-definition}


You replaced "in Go" with "using the Go SDK" above so maybe you can replace this with 'using the Go SDK' as well

angelazhou32 · 2024-08-01T20:12:47Z

docs/develop/go/core-application.mdx

@@ -567,7 +439,9 @@ func (a *YourActivityObject) YourActivityDefinition(ctx context.Context, param Y
 }
 ```

-### How to customize Activity Type in Go {#customize-activity-type}
+### Customize Activity Type in Go {#customize-activity-type}


You replaced "in Go" with "using the Go SDK" above so maybe you can replace this with 'using the Go SDK' as well

+1 also Type/Types

angelazhou32 · 2024-08-01T20:13:28Z

docs/develop/go/core-application.mdx

@@ -681,6 +559,8 @@ if err != nil {

 ### Go ActivityOptions reference {#activity-options-reference}

+**How to use Go ActivityOptions reference using the Go SDK**


Suggested change

**How to use Go ActivityOptions reference using the Go SDK**

**How to configure `ActivityOptions` using the Go SDK**

angelazhou32 · 2024-08-01T20:14:00Z

docs/develop/go/core-application.mdx

-### How to set WorkerOptions in Go {#workeroptions}
+### Set WorkerOptions in Go {#workeroptions}
+
+**How to set WorkerOptions using the Go SDK**


Suggested change

**How to set WorkerOptions using the Go SDK**

**How to set 1WorkerOptions` using the Go SDK**

Same for line 894

Except without the number 1

angelazhou32 · 2024-08-01T20:14:31Z

docs/develop/go/core-application.mdx

-### How to set RegisterWorkflowOptions in Go {#registerworkflowoptions}
+### Set RegisterWorkflowOptions in Go {#registerworkflowoptions}
+
+**How to set RegisterWorkflowOptions using the Go SDK**


Suggested change

**How to set RegisterWorkflowOptions using the Go SDK**

**How to set `RegisterWorkflowOptions` using the Go SDK**

Same for line 1433

fairlydurable · 2024-08-01T21:40:47Z

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

@@ -24,9 +24,10 @@ func SimpleWorkflow(ctx workflow.Context, value string) error {

 To check whether a Workflow Execution was spawned as a result of Continue-As-New, you can check if `workflow.GetInfo(ctx).ContinuedExecutionRunID` is not empty (i.e. `""`).

-**Notes**
+:::note


I'm leaving this as a non-blocking comment as it was mostly a Patrick-driven thing as far as I understand but somewhere in our various style rules there's a rule that says we always put a title in.

New regime, we can figure it out. I don't have dog in this fight, just reporting in. Maybe check with Brian?

fairlydurable · 2024-08-01T21:41:38Z

docs/develop/go/debugging.mdx

@@ -67,270 +71,3 @@ For more information, see [Metrics](/develop/go/observability#metrics) for setti

 Debug Server performance with [Cloud metrics](/cloud/metrics/) or [self-hosted Server metrics](/self-hosted-guide/production-checklist#scaling-and-metrics).

-## How to test Workflow Definitions in Go {#testing-and-debugging}


This is a HUGE HUGE removal of content. Was that intentional?

Putting this here: Any removals are likely because they are being moved to a new spot to align with the migration and IA rework of the dev guides. The .NET one was a manual migration since the rest weren't, we need to make sure they are still manually moved. ✔️

fairlydurable · 2024-08-01T21:42:34Z

docs/develop/go/core-application.mdx


-This section describes how to install the [Temporal CLI](/cli) and run a development Temporal Service.


This is HUGE removal of material. Just making sure it's intentional.

Haven't looked back at this but any removals are likely because they are being moved to a new spot to align with the migration. The .NET one was a manual migration since the rest weren't, need to make sure they are still manually moved. ✔️

fairlydurable · 2024-08-01T21:43:02Z

docs/develop/go/core-application.mdx

@@ -86,161 +86,19 @@ tags:
 description: The Foundations section of the Temporal Developer's guide introduces essential concepts for building and running a Temporal Application, outlining steps to start Workflow and Activity Execution, running development Workers, and installing the Temporal CLI.
 ---

-The Foundations section of the Temporal Developer's guide covers the minimum set of concepts and implementation details needed to build and run a [Temporal Application](/temporal#temporal-application)—that is, all the relevant steps to start a [Workflow Execution](#develop-workflows) that executes an [Activity](#activity-definition).
+This page shows how to do the following:

 In this section you can find the following:


Do you need both 89 and 91?

fairlydurable · 2024-08-01T21:45:25Z

docs/develop/go/core-application.mdx

@@ -882,7 +762,9 @@ if err != nil {
 }
 ```

-### How to get the results of an Activity Execution {#get-activity-results}
+### Get the results of an Activity Execution {#get-activity-results}


Consider 'retrieve' vs 'get'

Also 'Activity Execution results' is shorter and more direct than 'of an'

fairlydurable · 2024-08-01T21:46:20Z

docs/develop/go/core-application.mdx

-### How to get the results of an Activity Execution {#get-activity-results}
+### Get the results of an Activity Execution {#get-activity-results}
+
+**How to get the results of an Activity Execution using the Go SDK**


fairlydurable · 2024-08-01T21:46:37Z

docs/develop/go/core-application.mdx

@@ -1009,7 +891,9 @@ func main() {
 // ...
 ```

-### How to set WorkerOptions in Go {#workeroptions}
+### Set WorkerOptions in Go {#workeroptions}


Backtick? Or space the words 'Worker options'

Also the Go SDK.

I'm going to stop mentioning the Go SDK now.

fairlydurable · 2024-08-01T21:48:22Z

docs/develop/go/core-application.mdx

-### How to set RegisterActivityOptions in Go {#registeractivityoptions}
+### Set RegisterActivityOptions in Go {#registeractivityoptions}
+
+**How to set RegisterActivityOptions using the Go SDK**


Backtick the code face or reword

fairlydurable · 2024-08-01T21:48:40Z

docs/develop/go/failure-detection.mdx

@@ -54,7 +54,7 @@ if err != nil {

 ### Workflow Retry Policy {#workflow-retries}

-**How to set a Workflow Retry Polciy using the Go SDK.**
+**How to set a Workflow Retry Policy using the Go SDK**


fairlydurable · 2024-08-01T21:49:18Z

docs/develop/go/failure-detection.mdx

@@ -122,7 +122,7 @@ if err != nil {

 ### Set a custom Activity Retry Policy {#activity-retries}


I looked it up. P is upper-case, so no complaints.

fairlydurable · 2024-08-01T21:49:46Z

docs/develop/go/index.mdx

@@ -40,11 +40,13 @@ The [Testing suite feature guide](/develop/go/testing-suite) shows how to set up

 - [Test frameworks](/develop/go/testing-suite#test-frameworks)
 - [Test setup](/develop/go/testing-suite#test-setup)
+- [Test Workflow Definitions in Go](/develop/go/testing-suite#test-workflow-definitions)


In the Go SDK? (oops, I promised to stop, but...)

fairlydurable · 2024-08-01T21:50:31Z

docs/develop/go/index.mdx

- [How to develop with Updates](/develop/go/message-passing#updates)
+- [Signals](/develop/go/message-passing#signals)
+- [Queries](/develop/go/message-passing#queries)
+- [Updates](/develop/go/message-passing#updates)


I hate that these are single words. However if they align with other SDK coverage, there's nothing to do about it.

fairlydurable · 2024-08-01T21:50:47Z

docs/develop/go/index.mdx

@@ -88,7 +90,6 @@ The [Debugging feature guide](/develop/go/debugging) covers the various ways to

 - [How to debug in a development environment](/develop/go/debugging#debug-in-a-development-environment)
 - [How to debug in a production environment](/develop/go/debugging#debug-in-a-production-environment)
- [How to test Workflow Definitions in Go](/develop/go/debugging#testing-and-debugging)


using the Go SDK

fairlydurable · 2024-08-01T21:51:04Z

docs/develop/go/index.mdx

@@ -137,7 +138,7 @@ The [Side Effects feature guide](/develop/go/side-effects) covers how to use Sid

 - [Side Effects](/develop/go/side-effects)

-## Manage Namespaces
+## Namespaces


I prefer the original

fairlydurable · 2024-08-01T21:51:35Z

docs/develop/go/message-passing.mdx

@@ -169,7 +169,7 @@ func YourWorkflowDefinition(ctx workflow.Context, param YourWorkflowParam) error

 ### Signal-With-Start {#signal-with-start}

-**How to use Signal-With-Start using the Go SDK.**
+**How to use Signal-With-Start using the Go SDK**


Codeface.

I have a meeting. I have to run. Sorry. Stopping here.

axfelix · 2024-08-05T19:52:53Z

docs/develop/go/temporal-client.mdx

@@ -2,7 +2,7 @@
 id: temporal-clients
 title: Temporal Client - Go SDK feature guide
 sidebar_label: Temporal Client
-description: Learn how to connect to Temporal Service or Cloud, start Workflow Executions, manage Workflow options, and retrieve Workflow results using the Go SDK. Follow detailed steps and code examples to effectively utilize Temporal’s capabilities.
+description: Learn how to connect to Temporal Service or Cloud, start Workflow Executions, manage Workflow options, and retrieve Workflow results using the Go SDK Follow detailed steps and code examples to effectively utilize Temporal’s capabilities.


?? Not sure if this was removed intentionally

axfelix · 2024-08-05T19:53:21Z

docs/develop/go/test-suites.mdx

@@ -55,6 +55,8 @@ This framework is suited for implementing unit tests as well as functional tests

 ## Test setup

+**How to setup tests using the Go SDK**


Suggested change

**How to setup tests using the Go SDK**

**How to set up tests using the Go SDK**

I think "set up" is 2 words when used like this, but check me on it

axfelix · 2024-08-05T19:55:20Z

docs/develop/go/test-suites.mdx

+and any subsequent parameters contain values for custom input parameters declared by the Workflow
+function.
+
+> Note that unless the Activity invocations are mocked or Activity implementation


Is this the best way for us to do admonitions here?

axfelix · 2024-08-05T19:55:46Z

docs/develop/go/test-suites.mdx

+
+After executing the Workflow in the above example, we assert that the Workflow ran through completion
+via the call to `s.env.IsWorkflowComplete()`. We also assert that no errors were returned by asserting
+on the return value of `s.env.GetWorkflowError()`. If our Workflow returned a value, we could have


Suggested change

on the return value of `s.env.GetWorkflowError()`. If our Workflow returned a value, we could have

the return value of `s.env.GetWorkflowError()`. If our Workflow returned a value, we could have

axfelix · 2024-08-05T19:56:50Z

docs/develop/go/test-suites.mdx

+
+#### Activity mocking and overriding
+
+When running unit tests on Workflows, we want to test the Workflow logic in isolation. Additionally,


"We want to" is rarely the best framing, imo... if it's not accurate to say "we need to" instead, I'd rewrite this a bit to clarify the benefits of doing it.

axfelix · 2024-08-05T19:57:39Z

docs/develop/go/test-suites.mdx

+With the mock set up we can now execute the Workflow via the `s.env.ExecuteWorkflow(...)` method and
+assert that the Workflow completed successfully and returned the expected error.
+
+Simply mocking the execution to return a desired value or error is a pretty powerful mechanism to


Suggested change

Simply mocking the execution to return a desired value or error is a pretty powerful mechanism to

Mocking the execution to return a desired value or error is a pretty powerful mechanism to

axfelix · 2024-08-05T19:59:42Z

Added just a few comments -- I think this is all the feedback I have on all the content that wasn't already reviewed above!

jsundai added 3 commits June 5, 2024 22:04

first set of edits on go

a6f3b0a

edit

ab00f10

edits on core app, namespace, test suites

d079071

vercel bot deployed to Preview June 12, 2024 19:36 View deployment

jsundai added 2 commits June 12, 2024 14:48

removing period

928e5e3

cancellation and asynch activity edits

4022128

vercel bot deployed to Preview June 12, 2024 19:58 View deployment

editing debugging and test-suites, aligning using Go SDK

ed38717

vercel bot deployed to Preview June 12, 2024 20:39 View deployment

editing data-encryption, selectors, continue-as-new, childworkflows

3ada8c1

vercel bot deployed to Preview June 12, 2024 21:15 View deployment

jsundai marked this pull request as ready for review June 21, 2024 22:55

jsundai requested a review from a team as a code owner June 21, 2024 22:55

angelazhou32 reviewed Aug 1, 2024

View reviewed changes

fairlydurable reviewed Aug 1, 2024

View reviewed changes

axfelix reviewed Aug 5, 2024

View reviewed changes

		@@ -681,6 +559,8 @@ if err != nil {

		### Go ActivityOptions reference {#activity-options-reference}

		How to use Go ActivityOptions reference using the Go SDK

	How to use Go ActivityOptions reference using the Go SDK
	How to configure `ActivityOptions` using the Go SDK

	How to set WorkerOptions using the Go SDK
	How to set 1WorkerOptions` using the Go SDK

	How to set RegisterWorkflowOptions using the Go SDK
	How to set `RegisterWorkflowOptions` using the Go SDK

		@@ -67,270 +71,3 @@ For more information, see [Metrics](/develop/go/observability#metrics) for setti

		Debug Server performance with [Cloud metrics](/cloud/metrics/) or [self-hosted Server metrics](/self-hosted-guide/production-checklist#scaling-and-metrics).

		## How to test Workflow Definitions in Go {#testing-and-debugging}


		This section describes how to install the [Temporal CLI](/cli) and run a development Temporal Service.

		@@ -122,7 +122,7 @@ if err != nil {

		### Set a custom Activity Retry Policy {#activity-retries}

		@@ -55,6 +55,8 @@ This framework is suited for implementing unit tests as well as functional tests

		## Test setup

		How to setup tests using the Go SDK

	How to setup tests using the Go SDK
	How to set up tests using the Go SDK

	on the return value of `s.env.GetWorkflowError()`. If our Workflow returned a value, we could have
	the return value of `s.env.GetWorkflowError()`. If our Workflow returned a value, we could have


		#### Activity mocking and overriding

		When running unit tests on Workflows, we want to test the Workflow logic in isolation. Additionally,

	Simply mocking the execution to return a desired value or error is a pretty powerful mechanism to
	Mocking the execution to return a desired value or error is a pretty powerful mechanism to

Go Feature Guide: Editing #2904

Are you sure you want to change the base?

Go Feature Guide: Editing #2904

Conversation

jsundai commented Jun 6, 2024

What does this PR do?

Notes to reviewers

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

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

fairlydurable Aug 1, 2024 • edited Loading

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

axfelix commented Aug 5, 2024

fairlydurable Aug 1, 2024 •

edited

Loading