Replace Latin abbreviations in hand-written docs - #5100
Open
Duncanma wants to merge 2 commits into
Open
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| If you need to include region, use short codes (for example, `aps1`, `use1`). | ||
| ::: | ||
|
|
||
| ## Organizational Patterns |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'Organizational Patterns' should use sentence-style capitalization.
| Integrate Temporal Cloud with your organization's identity provider via SAML 2.0 for centralized authentication. SSO allows you to enforce your corporate login policies (MFA, password complexity, etc.). When you configure SAML with Temporal Cloud, you can disable social logins (i.e. Microsoft, Google) by opening a support ticket. | ||
| Integrate Temporal Cloud with your organization's identity provider via SAML 2.0 for centralized authentication. SSO allows you to enforce your corporate login policies (such as MFA and password complexity). When you configure SAML with Temporal Cloud, you can disable social logins (that is, Microsoft, Google) by opening a support ticket. | ||
|
|
||
| #### 2. Use Least-Privilege Roles for Temporal Cloud Users |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] '2. Use Least-Privilege Roles for Temporal Cloud Users' should use sentence-style capitalization.
| For non-human access (CI/CD pipelines, backend services), use [Temporal Cloud Service Accounts](/cloud/manage-access/service-accounts) instead of shared user logins. Service Accounts are machine identities that can be granted specific permissions without ties to an individual. Create separate Service Accounts with unique API keys for different applications or microservices, and apply least privilege to each (e.g. a service account that only has access to one Namespace). | ||
| For non-human access (CI/CD pipelines, backend services), use [Temporal Cloud Service Accounts](/cloud/manage-access/service-accounts) instead of shared user logins. Service Accounts are machine identities that can be granted specific permissions without ties to an individual. Create separate Service Accounts with unique API keys for different applications or microservices, and apply least privilege to each (for example, a service account that only has access to one Namespace). | ||
|
|
||
| ## Secure Application Authentication and API Access |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'Secure Application Authentication and API Access' should use sentence-style capitalization.
| Ensure that your production Namespace uses stricter network controls (e.g. only accessible from the prod network) and that credentials for it are separate from non-prod Namespaces. This limits the impact of any compromise in a lower environment, and as workflow data is only visible to users with access to that Namespace, separating environments by Namespace also enforces data-visibility boundaries. | ||
| Ensure that your production Namespace uses stricter network controls (for example, only accessible from the prod network) and that credentials for it are separate from non-prod Namespaces. This limits the impact of any compromise in a lower environment, and as workflow data is only visible to users with access to that Namespace, separating environments by Namespace also enforces data-visibility boundaries. | ||
|
|
||
| ## Data Protection and Encryption |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'Data Protection and Encryption' should use sentence-style capitalization.
| | **Multi-Cloud Replication** | **If you need the highest level of disaster tolerance, protecting against outages of an entire cloud provider (e.g., AWS or GCP)** | 99.99% | ≤ 20 minutes | Near-zero (≈ seconds) | | ||
| | **Multi-Cloud Replication** | **If you need the highest level of disaster tolerance, protecting against outages of an entire cloud provider (for example, AWS or GCP)** | 99.99% | ≤ 20 minutes | Near-zero (≈ seconds) | | ||
|
|
||
| ### Best Practices: |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'Best Practices:' should use sentence-style capitalization.
| @@ -424,7 +424,7 @@ track, and manage namespaces more easily. | |||
| ### Tag Structure and Limits | |||
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'Tag Structure and Limits' should use sentence-style capitalization.
| @@ -40,7 +40,7 @@ Complete your migration to the OpenMetrics endpoint before this date. | |||
| ## Why We're Making This Change | |||
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'Why We're Making This Change' should use sentence-style capitalization.
| @@ -148,7 +148,7 @@ Merely matching on the channel doesn't consume the message; it has to be explici | |||
|
|
|||
| ## Query Selector state | |||
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'Query Selector state' should use sentence-style capitalization.
| @@ -51,7 +51,7 @@ A **Pinned** Workflow is guaranteed to complete on a single Worker Deployment Ve | |||
|
|
|||
| ### Auto-Upgrade Workflows {/* #auto-upgrade */} | |||
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'Auto-Upgrade Workflows *********************' should use sentence-style capitalization.
| @@ -115,7 +115,7 @@ All Cloud customers pay for support as part of their plan. | |||
| ### Access Temporal Support | |||
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'Access Temporal Support' should use sentence-style capitalization.
Contributor
📖 Docs PR preview links
|
brianmacdonald-temporal
approved these changes
Aug 12, 2026
Duncanma
marked this pull request as ready for review
August 12, 2026 20:32
Duncanma
enabled auto-merge (squash)
August 12, 2026 20:33
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
e.g./eg.with “for example” andi.e./ie.with “that is” in hand-written docs to match the new ValeGoogle.LatinCI rule.etc.cases; keep open lists with “such as” / “for example” instead of closing them to only the named items.docs/cli/command-reference/unchanged (no post-process change in this PR).Test plan
vale --config .vale-ci.ini docs/— remainingGoogle.Latinhits are only in generated CLI command-referenceyarn buildpassed on commit┆Attachments: EDU-6946 Replace Latin abbreviations in hand-written docs