Nexus minor README update #396
Conversation
nexus/README.md
Outdated
| Nexus is currently available as | ||
| [Public Preview](https://docs.temporal.io/evaluate/development-production-features/release-stages). | ||
| [General Availability](https://docs.temporal.io/evaluate/development-production-features/release-stages#general-availability). |
There was a problem hiding this comment.
IMO we should just remove the whole statement about availability (GA is the default availability of all of our software unless stated otherwise)
nexus/caller/workflows.go
Outdated
| @@ -32,6 +32,7 @@ func HelloCallerWorkflow(ctx workflow.Context, name string, language service.Lan | |||
|
|
|||
| // Optionally wait for the operation to be started. NexusOperationExecution will contain the operation token in | |||
| // case this operation is asynchronous. | |||
| // TODO: Is it worth explaining what you can do with the nexus operation token? | |||
There was a problem hiding this comment.
@prasek small feedback on this sample, it's mentioned that there's an operation token if the operation is async, but as someone learning about nexus, I don't know why that's important or what its used for. I think if we mention the operation token here, we should give a little more information on its use
There was a problem hiding this comment.
Just to note, please remove the TODO before merging
There was a problem hiding this comment.
I do agree we should explain or link to an explanation of the token
There was a problem hiding this comment.
@yuandrew thanks agree we should include more here from the content in https://docs.temporal.io/nexus/operations of note
Unlike a traditional RPC, an asynchronous Nexus Operation has an operation token that can be used to re-attach to a long-lived Nexus Operation, for example, one backed by a Temporal Workflow. Nexus Operations support a uniform interface to get the status of an operation or its result, receive a completion callback, or cancel the operation – all of which are fully integrated into the Temporal Platform.
Asynchronous Nexus Operations, created with the New-Workflow-Run-Operation SDK helper, will return a Nexus Operation token, that can be used to perform additional actions like canceling an Operation.
dropped a suggestion above.
nexus/caller/workflows.go
Outdated
| @@ -32,6 +32,7 @@ func HelloCallerWorkflow(ctx workflow.Context, name string, language service.Lan | |||
|
|
|||
| // Optionally wait for the operation to be started. NexusOperationExecution will contain the operation token in | |||
| // case this operation is asynchronous. | |||
There was a problem hiding this comment.
| // case this operation is asynchronous. | |
| // case this operation is asynchronous, which is a handle that can be used to perform additional actions like cancelling an operation. |
What was changed
Removed Public preview line now that nexus is GA.
Fixed some typos, added a feedback point on the nexus sample
Why?
Checklist
Closes
How was this tested: