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

SDK-1486: Python update docs #2976

Merged
merged 25 commits into from
Aug 22, 2024
Merged

Conversation

dandavison
Copy link
Contributor

@dandavison dandavison commented Jul 26, 2024

[rendered]

This is a new version of the message-passing documentation for Python. It follows on from the new top-level section on https://docs.temporal.io/encyclopedia/workflow-message-passing that @drewhoskins-temporal recently wrote. The significant changes here are:

  • There is now a code sample at the top of the page that will immediately give many visitors to the page what they're looking for: it is minimal, but it shows how to define Query, Signal, and Update handlers, and an Update validator, and has one-line comments introducing the concepts.

  • Following the style taken in https://docs.temporal.io/encyclopedia/workflow-message-passing, the document recognizes that many aspects of Signal and Update handling can be covered together. This avoids a lot of repetition.

  • In particular, a new section named Message handler patterns gives Python-specific discussion and examples of the content outlined in encyclopedia/workflow-message-passing.

  • Similarly, there was no need to discuss dynamic handlers separately for Signal, Query, and Update since the signatures are the same.

The structure of the document is (I'll keep this up-to-date it it changes)

## Writing message handlers
  ### Query handlers {#handle-query}
  ### Signal handlers {#handle-signal}
  ### Update handlers and validators {#handle-update}

## Sending messages
  ### Sending a Query {#send-query}
  ### Sending a Signal
    #### Sending a Signal from a Client {#send-signal-from-client}
    #### Sending a Signal from a Workflow {#send-signal-from-workflow}
    #### Signal-With-Start {#signal-with-start}
  ### Sending an Update {#send-update}
    #### 1. Use [`execute_update`](https://python.temporal.io/temporalio.client.WorkflowHandle.html#execute_update) to wait for the update to complete
    #### 2. Use [`start_update`](https://python.temporal.io/temporalio.client.WorkflowHandle.html#start_update) to receive a handle as soon as the update is accepted or rejected
    #### Non-type safe APIs

## Message handler patterns {#message-handler-patterns}
  ### Async handlers {#async-handlers}
    #### Waiting
    #### Use `asyncio.Lock` to prevent concurrent handler execution {#control-handler-concurrency}
    #### Finishing handlers before the Workflow completes {#wait-for-message-handlers}

## Troubleshooting
  ### Problems when sending a Signal
  ### Problems when sending an Update
  ### Problems when sending a Query
## Dynamic Handlers {#dynamic-handler}
  ### Set a Dynamic Signal, Query, or Update handler {#set-a-dynamic-signal}
  ### Set a Dynamic Workflow {#set-a-dynamic-workflow}
  ### Set a Dynamic Activity {#set-a-dynamic-activity}

TODO:

  • get_update_info()
  • add "workflow execution already completed" code

@dandavison dandavison force-pushed the sdk-1486-python-message-handlers branch from f1a12dd to 966f210 Compare July 27, 2024 00:44
@dandavison dandavison force-pushed the sdk-1486-python-message-handlers branch from 966f210 to 6a1a381 Compare July 27, 2024 00:46
@dandavison dandavison force-pushed the sdk-1486-python-message-handlers branch from 47f2032 to e07a468 Compare August 6, 2024 17:59
@dandavison dandavison force-pushed the sdk-1486-python-message-handlers branch from e07a468 to c270eb0 Compare August 7, 2024 15:55
@dandavison dandavison force-pushed the sdk-1486-python-message-handlers branch from c270eb0 to 59bbf4e Compare August 7, 2024 15:56
@dandavison dandavison force-pushed the sdk-1486-python-message-handlers branch from 59bbf4e to 89181c3 Compare August 7, 2024 16:03
@dandavison dandavison force-pushed the sdk-1486-python-message-handlers branch from 8bd662b to c51a9a0 Compare August 7, 2024 17:45
@dandavison dandavison force-pushed the sdk-1486-python-message-handlers branch 2 times, most recently from 77fd625 to 79ee58a Compare August 7, 2024 17:57
@dandavison dandavison marked this pull request as ready for review August 7, 2024 18:59
@dandavison dandavison requested a review from a team as a code owner August 7, 2024 18:59
@dandavison dandavison force-pushed the sdk-1486-python-message-handlers branch from fd41b90 to 2b77b3f Compare August 7, 2024 19:31
Copy link
Contributor

@drewhoskins-temporal drewhoskins-temporal left a comment

Choose a reason for hiding this comment

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

Looks good, mostly minor comments. Main question is just to refine our posture on how much explanatory text goes here vs in the overview docs, and how we link to the overview docs, which I've flagged in a scattershot fashion in the inline comments.
It's convenient to have things here for people who like to dive right in. But I'm worried about a middle ground where we say some important things but not others.
I've had two experiences with temporal's language specific docs where they didn't answer my question, and I wasn't aware that the answer was in the overview docs. (that is, wasn't aware that there were overview docs on those topics and at this time I had not internalized the overall structure of the docs.)
So, liberal upward linking is probably the main thing I would recommend, and then use judgment about whether to repeat things here (and maybe overall I would recommend doing it less than you are and rely more on the links. This would ensure people are getting the best version of our intro on these topics, which we can maintain carefully.).

docs/develop/python/message-passing.mdx Outdated Show resolved Hide resolved
docs/develop/python/message-passing.mdx Outdated Show resolved Hide resolved
docs/develop/python/message-passing.mdx Show resolved Hide resolved
docs/develop/python/message-passing.mdx Outdated Show resolved Hide resolved
docs/develop/python/message-passing.mdx Outdated Show resolved Hide resolved
docs/develop/python/message-passing.mdx Outdated Show resolved Hide resolved
docs/develop/python/message-passing.mdx Outdated Show resolved Hide resolved
docs/develop/python/message-passing.mdx Outdated Show resolved Hide resolved
docs/develop/python/message-passing.mdx Outdated Show resolved Hide resolved
docs/develop/python/message-passing.mdx Outdated Show resolved Hide resolved
Copy link
Member

@cretz cretz left a comment

Choose a reason for hiding this comment

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

Some nits here and there, but overall LGTM

docs/develop/python/message-passing.mdx Outdated Show resolved Hide resolved
docs/develop/python/message-passing.mdx Outdated Show resolved Hide resolved
docs/develop/python/message-passing.mdx Outdated Show resolved Hide resolved
docs/develop/python/message-passing.mdx Outdated Show resolved Hide resolved
docs/develop/python/message-passing.mdx Outdated Show resolved Hide resolved
docs/develop/python/message-passing.mdx Outdated Show resolved Hide resolved
docs/develop/python/message-passing.mdx Outdated Show resolved Hide resolved
docs/develop/python/message-passing.mdx Outdated Show resolved Hide resolved
docs/develop/python/message-passing.mdx Outdated Show resolved Hide resolved
docs/develop/python/message-passing.mdx Outdated Show resolved Hide resolved
Copy link
Contributor Author

@dandavison dandavison left a comment

Choose a reason for hiding this comment

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

Thanks for the review @drewhoskins-temporal! I believe I've responded to all your comments. I've added several more uplinks.

Turning to @cretz's review now which also looks very helpful.

docs/develop/python/message-passing.mdx Show resolved Hide resolved
docs/develop/python/message-passing.mdx Outdated Show resolved Hide resolved
docs/develop/python/message-passing.mdx Outdated Show resolved Hide resolved
docs/develop/python/message-passing.mdx Outdated Show resolved Hide resolved
docs/develop/python/message-passing.mdx Outdated Show resolved Hide resolved
docs/develop/python/message-passing.mdx Outdated Show resolved Hide resolved
docs/develop/python/message-passing.mdx Outdated Show resolved Hide resolved
docs/develop/python/message-passing.mdx Outdated Show resolved Hide resolved
docs/develop/python/message-passing.mdx Outdated Show resolved Hide resolved
docs/develop/python/message-passing.mdx Outdated Show resolved Hide resolved
@dandavison
Copy link
Contributor Author

Is this ready to transition from SDK-1486 to EDU-671?

Yes, over to docs team!

@dandavison dandavison force-pushed the sdk-1486-python-message-handlers branch 2 times, most recently from 4fbaaca to ccf39ea Compare August 16, 2024 03:52
…#3018)

* Fix incorrect Grafana Dashboard setup (#3012)

* EDU-2658: AUG 12 PUB Updates role documentation to add new AccountOwner coverage (#3003)

* EDU-2658: Updates role documentation to add new AccountOwner coverage

* Respond to Unni feedback

* Responding to Unni feedback 14 Aug AM

* EDU-2658: Responds to Cap'n Beardo

* Maintenance: Fixing linking for Workflow under Maximum Attempts  (#3011)

* typo

* rephrasing sentence

* adds data converter stuff (#3004)

* adds data converter stuff

* incorporates brian suggestions

* incorporate alex suggestions

* adds ts code block

* removes we and changes it to you

* Initial sanity check for Dan

* Initial sanity check for Dan

* Continuing first pass. Stopping for the day

* EDU-2999: Adds table columns and rows to updated user roles with AccountOwner role (#3015)

* EDU-2999: Adds table columns and rows to updated user roles with AccountOwner

* Updating table with feedback

* Feedback from Manu

* mid update

* Update docs/production-deployment/cloud/account-setup/users.mdx

Co-authored-by: Brian P. Hogan <[email protected]>

---------

Co-authored-by: Brian P. Hogan <[email protected]>

* Morning discussion

* Adding in rps and aps in the glossary (#3010)

* adding in rps and aps in the glossary

* updating definition

* Resolves Heartbeat Throttling Coverage Omits Handling of Final Heartbeat (#3009)

* adding section about final heartbeat isn't subject to throttling if the Activity Execution fails

* removing part of sentence

* Responding to feedback

* Typos

* Typos

* Responding to late Monday request

---------

Co-authored-by: Jwahir Sundai <[email protected]>
Co-authored-by: angelazhou32 <[email protected]>
Co-authored-by: Brian P. Hogan <[email protected]>
@dandavison
Copy link
Contributor Author

Erica's changes are merged into this one; this PR is now just waiting for an approval from docs team.

Copy link
Contributor

@axfelix axfelix left a comment

Choose a reason for hiding this comment

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

Stamped! Thanks for working with us so much on this one. Really happy with how it turned out.

@dandavison
Copy link
Contributor Author

Thanks @axfelix and @fairlydurable.

I've added two final commits for @fairlydurable to review:

  1. changing a code snippet only to address an uresolved review comment above: 2820990

  2. Adding a line documenting workflow.current_update_info which should be included but was not: 6446f01

I'll obviously let you know if I think of any more omissions, but other than that over to you for merge.

@fairlydurable fairlydurable changed the title Python update docs SDK-1486: Python update docs Aug 22, 2024
@fairlydurable fairlydurable merged commit 5a066fd into main Aug 22, 2024
3 checks passed
@fairlydurable fairlydurable deleted the sdk-1486-python-message-handlers branch August 22, 2024 19:03
fairlydurable added a commit that referenced this pull request Sep 16, 2024
…ated languages (#3048)

* Updating docusaurus.config.js (#2987)

* Jl apikeys (#2998)

* Initial rewrite of the API Keys page

* Spelling fix | validated CLI and SDK samples function

* Updated Service Accounts docs

* Updates to api keys docs from PM review

* Updates to api keys docs from PM review #2

* Updates to api keys and service account from PR review #3

* Updates to sa docs.

* resolving my feedback

---------

Co-authored-by: Jwahir Sundai <[email protected]>

* Divide High Availability Content into Separate Pages (#2986)

* splitting up high availability page

* limiting to mrn

* format and change ensures to ensure

* EDU-2962: Restores 'Manage your MRN top level link' (#3007)

* Moving introduction to temporal cloud under evaluate (#2971)

* moving introduction to temporal cloud as evaluate material

* adding in self-hosted vs cloud content in overview

* adding in choosing btw cloud and self hosted

* edits from review

* formatting and more edits

* removing sentence

* after running yarn format

* making sure changes are up to date

* chore: fix typo "SandboxeWorkflowRunner" (#2977)

Co-authored-by: Jwahir Sundai <[email protected]>

* Fixed PHP example code syntax (#2980)

Co-authored-by: Jwahir Sundai <[email protected]>

* add note about workflow,host,worker specific task queues (#2993)

* add note about workflow,host,worker specific task queues

* vale nits

* move clarifying text to below code sample

* Fix incorrect Grafana Dashboard setup (#3012)

* EDU-2658: AUG 12 PUB Updates role documentation to add new AccountOwner coverage (#3003)

* EDU-2658: Updates role documentation to add new AccountOwner coverage

* Respond to Unni feedback

* Responding to Unni feedback 14 Aug AM

* EDU-2658: Responds to Cap'n Beardo

* Maintenance: Fixing linking for Workflow under Maximum Attempts  (#3011)

* typo

* rephrasing sentence

* adds data converter stuff (#3004)

* adds data converter stuff

* incorporates brian suggestions

* incorporate alex suggestions

* adds ts code block

* removes we and changes it to you

* EDU-2999: Adds table columns and rows to updated user roles with AccountOwner role (#3015)

* EDU-2999: Adds table columns and rows to updated user roles with AccountOwner

* Updating table with feedback

* Feedback from Manu

* mid update

* Update docs/production-deployment/cloud/account-setup/users.mdx

Co-authored-by: Brian P. Hogan <[email protected]>

---------

Co-authored-by: Brian P. Hogan <[email protected]>

* Adding in rps and aps in the glossary (#3010)

* adding in rps and aps in the glossary

* updating definition

* Resolves Heartbeat Throttling Coverage Omits Handling of Final Heartbeat (#3009)

* adding section about final heartbeat isn't subject to throttling if the Activity Execution fails

* removing part of sentence

* Update get-started.mdx (#3019)

Changed Global Admin to Account Owner

* fix inaccurate description of workflow delay

* EDU-2853: clarify local activity execution failure in references (#3016)

* clarify local activity execution failure in references

* non-core sdk clarification

---------

Co-authored-by: Erica Sadun <[email protected]>

* EDU-1844: duplicate workflow clarification (#3014)

* duplicate workflow clarification

* relative links

* 1 sentence per line

* copyedits

---------

Co-authored-by: Erica Sadun <[email protected]>

* EDU-2837: clarify datadog subsection in cloud docs is a tutorial (#3023)

* clarify datadog subsection in cloud docs is a tutorial

* remove misleading sentence about promQL

* EDU-2838: update the service health and worker health docs (#3024)

* update the service health and worker health docs

* remove pseudo mathml because it doesn't scroll or wrap

* remove escaping from pseudo mathml

* copyedits

* Update docs/production-deployment/cloud/service-health.mdx

Co-authored-by: Erica Sadun <[email protected]>

* Update docs/production-deployment/cloud/service-health.mdx

Co-authored-by: Erica Sadun <[email protected]>

* Update docs/production-deployment/cloud/worker-health.mdx

Co-authored-by: Erica Sadun <[email protected]>

* Update docs/production-deployment/cloud/worker-health.mdx

Co-authored-by: Erica Sadun <[email protected]>

* Update docs/production-deployment/cloud/worker-health.mdx

Co-authored-by: Erica Sadun <[email protected]>

* Update docs/production-deployment/cloud/worker-health.mdx

Co-authored-by: Erica Sadun <[email protected]>

* Update docs/production-deployment/cloud/worker-health.mdx

Co-authored-by: Erica Sadun <[email protected]>

* Update docs/production-deployment/cloud/worker-health.mdx

Co-authored-by: Erica Sadun <[email protected]>

* present participles

---------

Co-authored-by: Erica Sadun <[email protected]>

* EDU-2934: AUG 12 PUB updates coverage for automatic failbacks (#3002)

* Waiting on feedback from MRN team

See also:
https://docs.google.com/document/d/1zUWgBhYprdaUb6imHThmr3P_V4aLp4bAcr_2qSjCl0c/edit#heading=h.4q3g0wrlw89w

* EDU-2934: AUG 12 PUB updates coverage for automatic failbacks

Also fixes consistent capitalization of failover and failback.

* Responding to Nikitha update

* EDU-2934: Updates failover as well

* Workflow Update Pre-release -> Public Preview (#3017)

* Workflow Update Pre-release -> Public Preview

* s/recommended/available/, remove bad OSS release

* Update broken link

* cleanup

---------

Co-authored-by: Erica Sadun <[email protected]>

* [ImgBot] Optimize images (#2991)

*Total -- 504.65kb -> 319.75kb (36.64%)

/static/img/private-link/details.png -- 164.08kb -> 92.36kb (43.71%)
/static/img/private-link/endpoint-created.png -- 54.89kb -> 31.11kb (43.33%)
/static/img/private-link/service-settings.png -- 54.71kb -> 34.83kb (36.33%)
/static/img/messages-workflow-loop.png -- 192.15kb -> 125.67kb (34.6%)
/static/img/private-link/vpc-endpoints.png -- 38.82kb -> 35.78kb (7.84%)

Signed-off-by: ImgBotApp <[email protected]>
Co-authored-by: ImgBotApp <[email protected]>
Co-authored-by: Erica Sadun <[email protected]>

* SDK-1486: Python update docs (#2976)

* Edit top-level message-passing docs

* Python update docs

* Update dynamic handlers section

* Drop exclamation marks

* DEV: use temp URL for sample

* Get rid of cruft before the code sample

* Changes in response to @drewhoskins-temporal's code review

* Add emojis to code comments

* Updates from an initial subset of @cretz's comments

* More updates from review

* Break up code sample

* WIP: exceptions

* Further evolution of "Exceptions" section (now Troubleshooting)

* Clarify benefit of Update

* Move Message-handling patterns ahead of Troubleshooting

* Add some intro and make Query snippet more self-contained

* EDU-671: Brings Python Workflow Message Handling into docs compliance (#3018)

* Fix incorrect Grafana Dashboard setup (#3012)

* EDU-2658: AUG 12 PUB Updates role documentation to add new AccountOwner coverage (#3003)

* EDU-2658: Updates role documentation to add new AccountOwner coverage

* Respond to Unni feedback

* Responding to Unni feedback 14 Aug AM

* EDU-2658: Responds to Cap'n Beardo

* Maintenance: Fixing linking for Workflow under Maximum Attempts  (#3011)

* typo

* rephrasing sentence

* adds data converter stuff (#3004)

* adds data converter stuff

* incorporates brian suggestions

* incorporate alex suggestions

* adds ts code block

* removes we and changes it to you

* Initial sanity check for Dan

* Initial sanity check for Dan

* Continuing first pass. Stopping for the day

* EDU-2999: Adds table columns and rows to updated user roles with AccountOwner role (#3015)

* EDU-2999: Adds table columns and rows to updated user roles with AccountOwner

* Updating table with feedback

* Feedback from Manu

* mid update

* Update docs/production-deployment/cloud/account-setup/users.mdx

Co-authored-by: Brian P. Hogan <[email protected]>

---------

Co-authored-by: Brian P. Hogan <[email protected]>

* Morning discussion

* Adding in rps and aps in the glossary (#3010)

* adding in rps and aps in the glossary

* updating definition

* Resolves Heartbeat Throttling Coverage Omits Handling of Final Heartbeat (#3009)

* adding section about final heartbeat isn't subject to throttling if the Activity Execution fails

* removing part of sentence

* Responding to feedback

* Typos

* Typos

* Responding to late Monday request

---------

Co-authored-by: Jwahir Sundai <[email protected]>
Co-authored-by: angelazhou32 <[email protected]>
Co-authored-by: Brian P. Hogan <[email protected]>

* Hold a lock in the async update example

* Mention workflow.current_update_info

* Fix error in existing docs

---------

Co-authored-by: Erica Sadun <[email protected]>
Co-authored-by: Jwahir Sundai <[email protected]>
Co-authored-by: angelazhou32 <[email protected]>
Co-authored-by: Brian P. Hogan <[email protected]>

* fix unnecessary line break in the middle of a word. (#3028)

* fix unnecessary line break in the middle of a word.

Co-authored-by: Erica Sadun <[email protected]>

* EDU-2958: Completes the Docs Team compliance process for EDU-2937 (#3025)

* EDU-2958: Completes the Docs Team compliance process for EDU-2937

Pass by Jonathan L for tech review

* Added figure, updated responding to review

* Respond to JL feedback about prerelease, public preview

* Remove unnecessary error check for GetHandle() (#2978) (#3029)

Co-authored-by: ulas <[email protected]>

* EDU-672: Updates .NET Message Passing

* clarify production applicability of metrics reference (#3022)

* EDU-2741: add new top level cloud observability suggestions (#3021)

* add new top level cloud observability suggestions

* copyediting

* copyedit

---------

Co-authored-by: Erica Sadun <[email protected]>

* add workflow metrics to cluster metrics reference (#3030)

* change use of their to your (#3031)

* EDU-3078: Updates Account Level Role Details Table (#3037)

- Add checkmarks to ListCreditLedgerEntries and ListGrants for the
  AccountOwner role.
- Remove those checkmarks for the Global Admin

* fix setup (#3041)

* Adds PAYG for Amazon Marketplace (#3040)

* Adds PAYG for Amazon Marketplace

* Updates wording for AWS FAQ

* Responding to Brian's review

* Chad's original

* adds billing and cost page (#3039)

* adds billing and cost page

* grammar update

* incorporates feedback

* change wording in invoice table

* moving page

* incorporate some suggestions

* renname some tabs

* remove word tab

* change description of balance due

* adds note about pricing page (#3045)

* EDU-672: Adds first draft

* Correct queries anchor

* Minor updates

* Fixed other signal part

* Revert "dynamic" section to that on main, but with an Update section

* s/Python/.NET/

* Fix heading levels

* Update docs/develop/dotnet/message-passing.mdx

Co-authored-by: Chad Retz <[email protected]>

* Update docs/develop/dotnet/message-passing.mdx

Co-authored-by: Chad Retz <[email protected]>

* Update docs/develop/dotnet/message-passing.mdx

Co-authored-by: Chad Retz <[email protected]>

* Update docs/develop/dotnet/message-passing.mdx

Co-authored-by: Chad Retz <[email protected]>

* Update docs/develop/dotnet/message-passing.mdx

Co-authored-by: Chad Retz <[email protected]>

* Add links to reference docs

* Fix malformed link

* Update docs/develop/dotnet/message-passing.mdx

Co-authored-by: Erica Sadun <[email protected]>

* Update docs/develop/dotnet/message-passing.mdx

Co-authored-by: Erica Sadun <[email protected]>

* Update docs/develop/dotnet/message-passing.mdx

Co-authored-by: Erica Sadun <[email protected]>

* Apply suggestions from code review

Co-authored-by: Erica Sadun <[email protected]>

* One more upcase

---------

Signed-off-by: ImgBotApp <[email protected]>
Co-authored-by: Jonathan Lacefield <[email protected]>
Co-authored-by: Jwahir Sundai <[email protected]>
Co-authored-by: Evan Cohen <[email protected]>
Co-authored-by: Grégory PLANCHAT <[email protected]>
Co-authored-by: Alex Garnett <[email protected]>
Co-authored-by: angelazhou32 <[email protected]>
Co-authored-by: Brian P. Hogan <[email protected]>
Co-authored-by: UPatel12 <[email protected]>
Co-authored-by: angelazhou32 <[email protected]>
Co-authored-by: Drew Hoskins <[email protected]>
Co-authored-by: imgbot[bot] <31301654+imgbot[bot]@users.noreply.github.com>
Co-authored-by: ImgBotApp <[email protected]>
Co-authored-by: Dan Davison <[email protected]>
Co-authored-by: ulas <[email protected]>
Co-authored-by: Chad Retz <[email protected]>
Co-authored-by: Chad Retz <[email protected]>
fairlydurable added a commit that referenced this pull request Sep 16, 2024
* Go SDK message passing docs

* Update Go message-passing docs

* Update encyclopedia links

* async -> blocking

* Reinstate section on processing signals in a workflow.Go routine

* Add an example of draining signals asynchronously

* EDU-672: Backport .NET coverage of Workflow Updates into existing updated languages (#3048)

* Updating docusaurus.config.js (#2987)

* Jl apikeys (#2998)

* Initial rewrite of the API Keys page

* Spelling fix | validated CLI and SDK samples function

* Updated Service Accounts docs

* Updates to api keys docs from PM review

* Updates to api keys docs from PM review #2

* Updates to api keys and service account from PR review #3

* Updates to sa docs.

* resolving my feedback

---------

Co-authored-by: Jwahir Sundai <[email protected]>

* Divide High Availability Content into Separate Pages (#2986)

* splitting up high availability page

* limiting to mrn

* format and change ensures to ensure

* EDU-2962: Restores 'Manage your MRN top level link' (#3007)

* Moving introduction to temporal cloud under evaluate (#2971)

* moving introduction to temporal cloud as evaluate material

* adding in self-hosted vs cloud content in overview

* adding in choosing btw cloud and self hosted

* edits from review

* formatting and more edits

* removing sentence

* after running yarn format

* making sure changes are up to date

* chore: fix typo "SandboxeWorkflowRunner" (#2977)

Co-authored-by: Jwahir Sundai <[email protected]>

* Fixed PHP example code syntax (#2980)

Co-authored-by: Jwahir Sundai <[email protected]>

* add note about workflow,host,worker specific task queues (#2993)

* add note about workflow,host,worker specific task queues

* vale nits

* move clarifying text to below code sample

* Fix incorrect Grafana Dashboard setup (#3012)

* EDU-2658: AUG 12 PUB Updates role documentation to add new AccountOwner coverage (#3003)

* EDU-2658: Updates role documentation to add new AccountOwner coverage

* Respond to Unni feedback

* Responding to Unni feedback 14 Aug AM

* EDU-2658: Responds to Cap'n Beardo

* Maintenance: Fixing linking for Workflow under Maximum Attempts  (#3011)

* typo

* rephrasing sentence

* adds data converter stuff (#3004)

* adds data converter stuff

* incorporates brian suggestions

* incorporate alex suggestions

* adds ts code block

* removes we and changes it to you

* EDU-2999: Adds table columns and rows to updated user roles with AccountOwner role (#3015)

* EDU-2999: Adds table columns and rows to updated user roles with AccountOwner

* Updating table with feedback

* Feedback from Manu

* mid update

* Update docs/production-deployment/cloud/account-setup/users.mdx

Co-authored-by: Brian P. Hogan <[email protected]>

---------

Co-authored-by: Brian P. Hogan <[email protected]>

* Adding in rps and aps in the glossary (#3010)

* adding in rps and aps in the glossary

* updating definition

* Resolves Heartbeat Throttling Coverage Omits Handling of Final Heartbeat (#3009)

* adding section about final heartbeat isn't subject to throttling if the Activity Execution fails

* removing part of sentence

* Update get-started.mdx (#3019)

Changed Global Admin to Account Owner

* fix inaccurate description of workflow delay

* EDU-2853: clarify local activity execution failure in references (#3016)

* clarify local activity execution failure in references

* non-core sdk clarification

---------

Co-authored-by: Erica Sadun <[email protected]>

* EDU-1844: duplicate workflow clarification (#3014)

* duplicate workflow clarification

* relative links

* 1 sentence per line

* copyedits

---------

Co-authored-by: Erica Sadun <[email protected]>

* EDU-2837: clarify datadog subsection in cloud docs is a tutorial (#3023)

* clarify datadog subsection in cloud docs is a tutorial

* remove misleading sentence about promQL

* EDU-2838: update the service health and worker health docs (#3024)

* update the service health and worker health docs

* remove pseudo mathml because it doesn't scroll or wrap

* remove escaping from pseudo mathml

* copyedits

* Update docs/production-deployment/cloud/service-health.mdx

Co-authored-by: Erica Sadun <[email protected]>

* Update docs/production-deployment/cloud/service-health.mdx

Co-authored-by: Erica Sadun <[email protected]>

* Update docs/production-deployment/cloud/worker-health.mdx

Co-authored-by: Erica Sadun <[email protected]>

* Update docs/production-deployment/cloud/worker-health.mdx

Co-authored-by: Erica Sadun <[email protected]>

* Update docs/production-deployment/cloud/worker-health.mdx

Co-authored-by: Erica Sadun <[email protected]>

* Update docs/production-deployment/cloud/worker-health.mdx

Co-authored-by: Erica Sadun <[email protected]>

* Update docs/production-deployment/cloud/worker-health.mdx

Co-authored-by: Erica Sadun <[email protected]>

* Update docs/production-deployment/cloud/worker-health.mdx

Co-authored-by: Erica Sadun <[email protected]>

* present participles

---------

Co-authored-by: Erica Sadun <[email protected]>

* EDU-2934: AUG 12 PUB updates coverage for automatic failbacks (#3002)

* Waiting on feedback from MRN team

See also:
https://docs.google.com/document/d/1zUWgBhYprdaUb6imHThmr3P_V4aLp4bAcr_2qSjCl0c/edit#heading=h.4q3g0wrlw89w

* EDU-2934: AUG 12 PUB updates coverage for automatic failbacks

Also fixes consistent capitalization of failover and failback.

* Responding to Nikitha update

* EDU-2934: Updates failover as well

* Workflow Update Pre-release -> Public Preview (#3017)

* Workflow Update Pre-release -> Public Preview

* s/recommended/available/, remove bad OSS release

* Update broken link

* cleanup

---------

Co-authored-by: Erica Sadun <[email protected]>

* [ImgBot] Optimize images (#2991)

*Total -- 504.65kb -> 319.75kb (36.64%)

/static/img/private-link/details.png -- 164.08kb -> 92.36kb (43.71%)
/static/img/private-link/endpoint-created.png -- 54.89kb -> 31.11kb (43.33%)
/static/img/private-link/service-settings.png -- 54.71kb -> 34.83kb (36.33%)
/static/img/messages-workflow-loop.png -- 192.15kb -> 125.67kb (34.6%)
/static/img/private-link/vpc-endpoints.png -- 38.82kb -> 35.78kb (7.84%)

Signed-off-by: ImgBotApp <[email protected]>
Co-authored-by: ImgBotApp <[email protected]>
Co-authored-by: Erica Sadun <[email protected]>

* SDK-1486: Python update docs (#2976)

* Edit top-level message-passing docs

* Python update docs

* Update dynamic handlers section

* Drop exclamation marks

* DEV: use temp URL for sample

* Get rid of cruft before the code sample

* Changes in response to @drewhoskins-temporal's code review

* Add emojis to code comments

* Updates from an initial subset of @cretz's comments

* More updates from review

* Break up code sample

* WIP: exceptions

* Further evolution of "Exceptions" section (now Troubleshooting)

* Clarify benefit of Update

* Move Message-handling patterns ahead of Troubleshooting

* Add some intro and make Query snippet more self-contained

* EDU-671: Brings Python Workflow Message Handling into docs compliance (#3018)

* Fix incorrect Grafana Dashboard setup (#3012)

* EDU-2658: AUG 12 PUB Updates role documentation to add new AccountOwner coverage (#3003)

* EDU-2658: Updates role documentation to add new AccountOwner coverage

* Respond to Unni feedback

* Responding to Unni feedback 14 Aug AM

* EDU-2658: Responds to Cap'n Beardo

* Maintenance: Fixing linking for Workflow under Maximum Attempts  (#3011)

* typo

* rephrasing sentence

* adds data converter stuff (#3004)

* adds data converter stuff

* incorporates brian suggestions

* incorporate alex suggestions

* adds ts code block

* removes we and changes it to you

* Initial sanity check for Dan

* Initial sanity check for Dan

* Continuing first pass. Stopping for the day

* EDU-2999: Adds table columns and rows to updated user roles with AccountOwner role (#3015)

* EDU-2999: Adds table columns and rows to updated user roles with AccountOwner

* Updating table with feedback

* Feedback from Manu

* mid update

* Update docs/production-deployment/cloud/account-setup/users.mdx

Co-authored-by: Brian P. Hogan <[email protected]>

---------

Co-authored-by: Brian P. Hogan <[email protected]>

* Morning discussion

* Adding in rps and aps in the glossary (#3010)

* adding in rps and aps in the glossary

* updating definition

* Resolves Heartbeat Throttling Coverage Omits Handling of Final Heartbeat (#3009)

* adding section about final heartbeat isn't subject to throttling if the Activity Execution fails

* removing part of sentence

* Responding to feedback

* Typos

* Typos

* Responding to late Monday request

---------

Co-authored-by: Jwahir Sundai <[email protected]>
Co-authored-by: angelazhou32 <[email protected]>
Co-authored-by: Brian P. Hogan <[email protected]>

* Hold a lock in the async update example

* Mention workflow.current_update_info

* Fix error in existing docs

---------

Co-authored-by: Erica Sadun <[email protected]>
Co-authored-by: Jwahir Sundai <[email protected]>
Co-authored-by: angelazhou32 <[email protected]>
Co-authored-by: Brian P. Hogan <[email protected]>

* fix unnecessary line break in the middle of a word. (#3028)

* fix unnecessary line break in the middle of a word.

Co-authored-by: Erica Sadun <[email protected]>

* EDU-2958: Completes the Docs Team compliance process for EDU-2937 (#3025)

* EDU-2958: Completes the Docs Team compliance process for EDU-2937

Pass by Jonathan L for tech review

* Added figure, updated responding to review

* Respond to JL feedback about prerelease, public preview

* Remove unnecessary error check for GetHandle() (#2978) (#3029)

Co-authored-by: ulas <[email protected]>

* EDU-672: Updates .NET Message Passing

* clarify production applicability of metrics reference (#3022)

* EDU-2741: add new top level cloud observability suggestions (#3021)

* add new top level cloud observability suggestions

* copyediting

* copyedit

---------

Co-authored-by: Erica Sadun <[email protected]>

* add workflow metrics to cluster metrics reference (#3030)

* change use of their to your (#3031)

* EDU-3078: Updates Account Level Role Details Table (#3037)

- Add checkmarks to ListCreditLedgerEntries and ListGrants for the
  AccountOwner role.
- Remove those checkmarks for the Global Admin

* fix setup (#3041)

* Adds PAYG for Amazon Marketplace (#3040)

* Adds PAYG for Amazon Marketplace

* Updates wording for AWS FAQ

* Responding to Brian's review

* Chad's original

* adds billing and cost page (#3039)

* adds billing and cost page

* grammar update

* incorporates feedback

* change wording in invoice table

* moving page

* incorporate some suggestions

* renname some tabs

* remove word tab

* change description of balance due

* adds note about pricing page (#3045)

* EDU-672: Adds first draft

* Correct queries anchor

* Minor updates

* Fixed other signal part

* Revert "dynamic" section to that on main, but with an Update section

* s/Python/.NET/

* Fix heading levels

* Update docs/develop/dotnet/message-passing.mdx

Co-authored-by: Chad Retz <[email protected]>

* Update docs/develop/dotnet/message-passing.mdx

Co-authored-by: Chad Retz <[email protected]>

* Update docs/develop/dotnet/message-passing.mdx

Co-authored-by: Chad Retz <[email protected]>

* Update docs/develop/dotnet/message-passing.mdx

Co-authored-by: Chad Retz <[email protected]>

* Update docs/develop/dotnet/message-passing.mdx

Co-authored-by: Chad Retz <[email protected]>

* Add links to reference docs

* Fix malformed link

* Update docs/develop/dotnet/message-passing.mdx

Co-authored-by: Erica Sadun <[email protected]>

* Update docs/develop/dotnet/message-passing.mdx

Co-authored-by: Erica Sadun <[email protected]>

* Update docs/develop/dotnet/message-passing.mdx

Co-authored-by: Erica Sadun <[email protected]>

* Apply suggestions from code review

Co-authored-by: Erica Sadun <[email protected]>

* One more upcase

---------

Signed-off-by: ImgBotApp <[email protected]>
Co-authored-by: Jonathan Lacefield <[email protected]>
Co-authored-by: Jwahir Sundai <[email protected]>
Co-authored-by: Evan Cohen <[email protected]>
Co-authored-by: Grégory PLANCHAT <[email protected]>
Co-authored-by: Alex Garnett <[email protected]>
Co-authored-by: angelazhou32 <[email protected]>
Co-authored-by: Brian P. Hogan <[email protected]>
Co-authored-by: UPatel12 <[email protected]>
Co-authored-by: angelazhou32 <[email protected]>
Co-authored-by: Drew Hoskins <[email protected]>
Co-authored-by: imgbot[bot] <31301654+imgbot[bot]@users.noreply.github.com>
Co-authored-by: ImgBotApp <[email protected]>
Co-authored-by: Dan Davison <[email protected]>
Co-authored-by: ulas <[email protected]>
Co-authored-by: Chad Retz <[email protected]>
Co-authored-by: Chad Retz <[email protected]>

* Fix encyclopedia links

* Add "error"

* Apply suggestions from code review

Co-authored-by: Erica Sadun <[email protected]>

* Fix link

---------

Signed-off-by: ImgBotApp <[email protected]>
Co-authored-by: Dan Davison <[email protected]>
Co-authored-by: Erica Sadun <[email protected]>
Co-authored-by: Jonathan Lacefield <[email protected]>
Co-authored-by: Jwahir Sundai <[email protected]>
Co-authored-by: Evan Cohen <[email protected]>
Co-authored-by: Grégory PLANCHAT <[email protected]>
Co-authored-by: Alex Garnett <[email protected]>
Co-authored-by: angelazhou32 <[email protected]>
Co-authored-by: Brian P. Hogan <[email protected]>
Co-authored-by: UPatel12 <[email protected]>
Co-authored-by: angelazhou32 <[email protected]>
Co-authored-by: Drew Hoskins <[email protected]>
Co-authored-by: imgbot[bot] <31301654+imgbot[bot]@users.noreply.github.com>
Co-authored-by: ImgBotApp <[email protected]>
Co-authored-by: ulas <[email protected]>
Co-authored-by: Chad Retz <[email protected]>
Co-authored-by: Chad Retz <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants