Skip to content

Commit 6bd8c27

Browse files
Duncanmalennessyy
andauthored
Revamp best-practices landing page (#5127)
* Revamp best-practices landing page and fix section inconsistencies The best-practices index only listed 7 of the section's 11 pages and gave no framing for how they relate. Regroup the index into four intro'd sections (namespace/tenancy/capacity, security, worker/workflow reliability, organizational enablement), relocate multi-tenant-patterns.mdx into best-practices/ where it's already tagged and cross-linked as belonging, and copyedit managing-aps-limits.mdx, security-controls.mdx, managing-namespace.mdx, and cloud-access-control.mdx for heading-case and word-choice consistency with the rest of the section. * Apply suggestion from @lennessyy Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com> --------- Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com>
1 parent c8e6506 commit 6bd8c27

11 files changed

Lines changed: 134 additions & 132 deletions

File tree

docs/best-practices/cloud-access-control.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ mechanics, see [Manage API keys](/cloud/api-keys) and [Manage service accounts](
2727

2828
Related guidance:
2929
- [Namespace best practices](/best-practices/managing-namespace)
30-
- [Multi-tenant application patterns](/production-deployment/multi-tenant-patterns)
30+
- [Multi-tenant application patterns](/best-practices/multi-tenant-patterns)
3131

3232
The high-level end-to-end rotation process is:
3333

@@ -52,7 +52,7 @@ In the case that you are using multiple certificates signed by the same CA, and
5252

5353
One convention is to give certificates a common name that matches the namespace. If you do this when using the same CA for dev and prod, then you can leverage Certificate Filters to prevent access to production environments. This is described in detail under the [authorization section](/cloud/certificates#control-authorization) of the documentation.
5454

55-
## Best practices
55+
## Recommendations
5656

5757
### Establish clear guidelines on authentication methods
5858

@@ -96,7 +96,7 @@ The way you partition Namespaces should usually match the way you partition mach
9696
granular.
9797

9898
For more on topology tradeoffs, see [Namespace best practices](/best-practices/managing-namespace) and
99-
[Multi-tenant application patterns](/production-deployment/multi-tenant-patterns).
99+
[Multi-tenant application patterns](/best-practices/multi-tenant-patterns).
100100

101101
### Rotate credentials without downtime
102102

docs/best-practices/index.mdx

Lines changed: 49 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -3,63 +3,75 @@ id: index
33
title: Best practices
44
sidebar_label: Best practices
55
description:
6-
Comprehensive best practices for working with Temporal, covering namespace management, security, and operational
7-
excellence.
6+
Prescriptive, validated guidance for platform teams and architects establishing Temporal standards, covering
7+
namespace and tenancy design, Cloud security, Worker and Workflow reliability, and organizational enablement.
88
toc_max_heading_level: 3
9-
hide_table_of_contents: true
9+
hide_table_of_contents: false
1010
keywords:
1111
- temporal best practices
1212
- operational excellence
1313
- security
1414
- namespace management
15+
- multi-tenancy
16+
- cost optimization
1517
tags:
1618
- Best Practices
1719
---
1820

19-
These guides outline foundational principles and best practices for using Temporal Cloud. It exists to provide a
20-
**validated, opinionated** framework that helps teams that either do not have an enablement plan for or want to evaluate
21-
and refine their use of Temporal.
21+
This section collects prescriptive, validated guidance for platform teams, architects, and developers establishing
22+
Temporal standards across an organization. Each page recommends a specific approach based on real-world deployments,
23+
rather than explaining how a feature works internally — for that, see [Encyclopedia](/temporal). Looking for a working
24+
code example instead of a principle? See [Guides](/guides) for pattern-by-pattern implementations with runnable code.
2225

23-
## Overview
26+
## Namespace, tenancy, and capacity
2427

25-
Without clearly defined Temporal standards, organizations often struggle with inconsistent Workflow implementations,
26-
fragmented best practices, and misaligned development approaches. This documentation framework helps developers
27-
establish robust Temporal standards by providing:
28+
Start here to decide how many Namespaces you need, how tenants share them, and what capacity model fits your traffic.
29+
These pages form one decision chain: draw your Namespace boundaries, decide how tenants share those boundaries, size
30+
your Actions-per-second capacity, and understand what it costs.
2831

29-
- **Proven foundation principles** that have been validated across diverse use cases
30-
- **Standardized implementation patterns** for teams to adopt consistently across projects
31-
- **Confidence in alignment** with Temporal's architectural principles and recommended practices
32+
- **[Namespace best practices](./managing-namespace.mdx)** — naming conventions, organizational patterns for splitting
33+
Namespaces, and production safeguards like deletion protection and Infrastructure as Code.
34+
- **[Multi-tenant application patterns](./multi-tenant-patterns.mdx)** — Task Queue and Namespace isolation patterns for
35+
multi-tenant applications, with worked capacity-planning examples.
36+
- **[Managing Actions per Second (APS) limits](./managing-aps-limits.mdx)** — why workloads hit APS limits, how to
37+
design Workflows that use Actions efficiently, and when to use Provisioned Capacity.
38+
- **[Cost optimization](./cost-optimization.mdx)** — common cost anti-patterns and strategies for reducing Actions and
39+
Storage costs without sacrificing observability.
3240

33-
By following this guidance, developers can define comprehensive Temporal standards that ensure their workflow
34-
orchestration implementations are maintainable, scalable, and aligned with platform best practices from the start.
41+
## Security and access control
3542

36-
## Target audience
43+
Temporal Cloud secures the managed service; you're responsible for how your applications authenticate to it and who can
44+
administer your account. These two pages cover both halves.
3745

38-
This section is intended for:
46+
- **[Managing Temporal Cloud access control](./cloud-access-control.mdx)** — choosing between mTLS certificates and API
47+
keys, structuring Service Accounts, and rotating credentials without downtime.
48+
- **[Security controls for Temporal Cloud](./security-controls.mdx)** — identity and access management, network
49+
isolation, data encryption, and availability guidance for a Temporal Cloud account.
3950

40-
- Developers responsible for building a Temporal Cloud practice within their organization.
41-
- Anyone building tutorials, courses, onboarding paths, or documentation
42-
- Partners or vendors creating Temporal-related learning materials
51+
## Worker and Workflow reliability
4352

44-
## Available guides
53+
These pages cover the full lifecycle of running reliable Workflows in production: deploy and tune Workers correctly,
54+
alert on the metrics that catch failures early, handle errors correctly in Workflow and Activity code, and validate
55+
that all of it survives real failure conditions before you rely on it.
4556

46-
- **[Managing a Namespace](./managing-namespace.mdx)** Best practices for configuring, managing, and optimizing Temporal
47-
Namespaces.
57+
- **[Worker deployment and performance](./worker.mdx)** — deployment, scaling, and tuning practices for Workers,
58+
illustrated with a reference application.
59+
- **[Alerting on Worker metrics](./worker-alerting.mdx)** — a recommended alert set with thresholds and triage links.
60+
- **[Error handling](./error-handling.mdx)** — categorizing failures, when to mark errors non-retryable, and
61+
implementing compensation with the Saga pattern.
62+
- **[Pre-production testing](./pre-production-testing.mdx)** — failure injection, load testing, and a game-day runbook
63+
for validating operational readiness.
4864

49-
- **[Managing Temporal Cloud Access Control](./cloud-access-control.mdx)** Guidelines for implementing proper access
50-
control and user management in Temporal Cloud.
65+
## Organizational enablement
5166

52-
- **[Security Controls for Temporal Cloud](./security-controls.mdx)** Comprehensive security practices for protecting
53-
your Temporal Cloud deployment.
67+
Once your own standards are established, the next challenge is getting every team to follow them without funneling
68+
every question through the platform team.
5469

55-
- **[Worker Deployment and Performance](./worker.mdx)** Best practices for deploying and optimizing Temporal Workers for
56-
performance and reliability.
70+
- **[Knowledge hub](./knowledge-hub.mdx)** — what belongs in an internal Temporal knowledge hub, how to measure its
71+
effectiveness, and how to keep it current.
5772

58-
- **[Cost Optimization](./cost-optimization.mdx)** Strategies for optimizing costs associated with workloads running on
59-
Temporal Cloud while maintaining Workflow reliability and observability.
60-
61-
- **[Pre-Production Testing](./pre-production-testing.mdx)** Experience-driven testing practices covering failure
62-
injection, load testing, and operational validation.
63-
64-
- **[Knowledge Hub](./knowledge-hub.mdx)** Best practices for building and maintaining an internal Temporal knowledge hub
65-
that accelerates developer onboarding, reduces platform team support load, and establishes consistent standards.
73+
:::note Scope
74+
Most of this section covers Temporal Cloud operations. Namespace best practices, Worker deployment, and error handling
75+
apply to self-hosted Temporal too; security controls, access control, cost optimization, and APS limits are
76+
Cloud-specific. For self-hosted security guidance, see [Security (self-hosted)](/self-hosted-guide/security).
77+
:::

0 commit comments

Comments
 (0)