Skip to content

Commit 3825650

Browse files
becholslennessyy
andauthored
Fix docs build warnings (#4353)
* Fix docs build warnings * throw error on broken anchor --------- Co-authored-by: Lenny Chen <lenny.chen@temporal.io>
1 parent 4041c88 commit 3825650

19 files changed

Lines changed: 1792 additions & 1323 deletions

File tree

docs/cloud/high-availability/failovers.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -381,7 +381,7 @@ Failover testing (also known as "<ToolTipTerm term="trigger testing" />)" can:
381381
Manual testing confirms the failover mechanism works as expected, so your system handles incidents effectively.
382382

383383
- **Assess replication lag**:
384-
In multi-region deployment, monitoring [replication lag](/cloud/high-availability/monitoring#replication-lag-metric) between regions is crucial.
384+
In multi-region deployment, monitoring [replication lag](/cloud/metrics/openmetrics/metrics-reference#temporal_cloud_v1_replication_lag_p99) between regions is crucial.
385385
Check the lag before initiating a failover to avoid rolling back Workflow progress.
386386
This is less important when using isolation domains as failover is usually instantaneous.
387387
Manual testing helps you practice this critical step and understand its impact.

docs/cloud/metrics/general-setup.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ To assign a certificate and generate your metrics endpoint, follow these steps:
5353

5454
After the page refreshes, the new metrics endpoint appears below **Endpoint**, in the form `https://<account-id>.tmprl.cloud/prometheus`.
5555
Use the endpoint to configure your observability tool.
56-
For example, if you use Grafana, see [Grafana data sources configuration](/cloud/metrics/prometheus-grafana#grafana-data-sources-configuration).
56+
For example, if you use Grafana, see [Grafana data source configuration](/cloud/metrics/prometheus-grafana#grafana-data-source-configuration).
5757

5858
You can also query via the [Prometheus HTTP API](https://prometheus.io/docs/prometheus/latest/querying/api/) at URLs like:
5959

docs/cloud/metrics/openmetrics/migration-guide.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -294,14 +294,14 @@ To size workloads for Temporal Cloud (for example, when migrating from self-host
294294

295295
| Old Metric (v0) | New Metric (v1) | New Labels |
296296
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------- | ---------- |
297-
| `temporal_cloud_v0_service_latency_bucket temporal_cloud_v0_service_latency_count temporal_cloud_v0_service_latency_sum` | `temporal_cloud_v1_service_latency_p99 temporal_cloud_v1_service_latency_p95 temporal_cloud_v1_service_latency_p50` | `region` |
297+
| `temporal_cloud_v0_service_latency_bucket temporal_cloud_v0_service_latency_count temporal_cloud_v0_service_latency_sum` | `temporal_cloud_v1_service_latency_p99 temporal_cloud_v1_service_latency_p95 temporal_cloud_v1_service_latency_p50` | `region` |
298298
| `temporal_cloud_v0_replication_lag_bucket temporal_cloud_v0_replication_lag_count temporal_cloud_v0_replication_lag_sum` | `temporal_cloud_v1_replication_lag_p99 temporal_cloud_v1_replication_lag_p95 temporal_cloud_v1_replication_lag_p50` | `region` |
299299

300300
#### Schedule Metrics
301301

302302
| Old Metric (v0) | New Metric (v1) | New Labels |
303303
| -------------------------------------------------------- | -------------------------------------------------------- | ---------- |
304-
| `temporal_cloud_v0_schedule_action_success_count` | `temporal_cloud_v1_schedule_action_success_count` | `region` |
304+
| `temporal_cloud_v0_schedule_action_success_count` | `temporal_cloud_v1_schedule_action_success_count` | `region` |
305305
| `temporal_cloud_v0_schedule_buffer_overruns_count` | `temporal_cloud_v1_schedule_buffer_overruns_count` | `region` |
306306
| `temporal_cloud_v0_schedule_missed_catchup_window_count` | `temporal_cloud_v1_schedule_missed_catchup_window_count` | `region` |
307307
| `temporal_cloud_v0_schedule_rate_limited_count` | `temporal_cloud_v1_schedule_rate_limited_count` | `region` |

docs/cloud/metrics/reference.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -106,17 +106,17 @@ Labels: temporal_account, temporal_namespace, operation, task_type, temporal_ser
106106

107107
#### temporal_cloud_v0_replication_lag_bucket
108108

109-
A histogram of [replication lag](/cloud/high-availability/monitoring#replication-lag-metric) during a specific time interval for a Namespace with high availability.
109+
A histogram of [replication lag](/cloud/metrics/openmetrics/metrics-reference#temporal_cloud_v1_replication_lag_p99) during a specific time interval for a Namespace with high availability.
110110
Labels: temporal_account, temporal_namespace, le
111111

112112
#### temporal_cloud_v0_replication_lag_count
113113

114-
The [replication lag](/cloud/high-availability/monitoring#replication-lag-metric) count during a specific time interval for a Namespace with high availability.
114+
The [replication lag](/cloud/metrics/openmetrics/metrics-reference#temporal_cloud_v1_replication_lag_p99) count during a specific time interval for a Namespace with high availability.
115115
Labels: temporal_account, temporal_namespace
116116

117117
#### temporal_cloud_v0_replication_lag_sum
118118

119-
The sum of [replication lag](/cloud/high-availability/monitoring#replication-lag-metric) during a specific time interval for a Namespace with high availability.
119+
The sum of [replication lag](/cloud/metrics/openmetrics/metrics-reference#temporal_cloud_v1_replication_lag_p99) during a specific time interval for a Namespace with high availability.
120120
Labels: temporal_account, temporal_namespace
121121

122122
### Schedule metrics {#schedule}

docs/cloud/rto-rpo.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Temporal has put extensive work into tools and processes that minimize the recov
7575

7676
However, user actions on a Namespace can affect the recovery point. For example, suddenly spiking into much higher throughput than a Namespace has seen before could create a period of replication lag where the replica falls behind the active.
7777

78-
Temporal provides a [replication lag](/cloud/high-availability/monitoring#replication-lag-metric) metric for each Namespace. This metric approximates the recovery point the Namespace would achieve in a worst case failure at that given moment.
78+
Temporal provides a [replication lag](/cloud/metrics/openmetrics/metrics-reference#temporal_cloud_v1_replication_lag_p99) metric for each Namespace. This metric approximates the recovery point the Namespace would achieve in a worst case failure at that given moment.
7979

8080
:::note
8181

docs/develop/dotnet/standalone-activities.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ public record ComposeGreetingInput(string Greeting, string Name);
135135
Running a Worker for Standalone Activities is the same as running a Worker for Workflow Activities —
136136
you create a Worker, register the Activity, and run the Worker. The Worker doesn't need to know
137137
whether the Activity will be invoked from a Workflow or as a Standalone Activity. See [How to develop
138-
a Worker](/develop/dotnet/core-application#run-a-dev-worker) for more details on Worker setup and
138+
a Worker](/develop/dotnet/core-application#run-worker-process) for more details on Worker setup and
139139
configuration options.
140140

141141
[src/StandaloneActivity/Program.cs](https://github.com/temporalio/samples-dotnet/blob/main/src/StandaloneActivity/Program.cs)

docs/encyclopedia/context-propagation.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,4 @@ Each SDK provides a **context propagator** interface you implement to control wh
2929

3030
Here are SDK-specific guides:
3131

32-
- [Go](/develop/go/observability#context-propagation)
32+
- [Go](/develop/go/context-propagation)

docs/encyclopedia/temporal-service/temporal-service-configuration.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ Temporal Cloud emits metrics through a Prometheus HTTP API endpoint, which can b
144144
For details on Cloud metrics and setup, see the following:
145145

146146
- [Temporal Cloud metrics reference](/cloud/metrics/)
147-
- [Set up Grafana with Temporal Cloud observability to view metrics](/cloud/metrics/prometheus-grafana#grafana-data-sources-configuration)
147+
- [Set up Grafana with Temporal Cloud observability to view metrics](/cloud/metrics/prometheus-grafana#grafana-data-source-configuration)
148148

149149
On the self-hosted Temporal Service, expose Prometheus endpoints in your Temporal Service configuration and configure Prometheus to scrape metrics from the endpoints.
150150
You can then set up your observability platform (such as Grafana) to use Prometheus as a data source.

docs/encyclopedia/visibility/search-attributes.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ This information is available in the Visibility store.
3333
:::caution Do not use sensitive data or PII in Search Attributes
3434

3535
Do not include sensitive data, secrets, or personally identifiable information (PII) in Search Attribute **names or values**.
36-
Search Attribute values are stored unencrypted in the Visibility store and are not processed by a custom [Payload Codec](/dataconversion#payload-codec).
36+
Search Attribute values are stored unencrypted in the Visibility store and are not processed by a custom [Payload Codec](/payload-codec#payload-codec).
3737
The Temporal Server must be able to read these values in plain text to support filtering and ordering, so encryption is not possible without breaking search functionality.
3838

3939
Attribute names are also visible in Namespace configuration, query expressions, and Temporal UI.

docs/encyclopedia/workers/tasks.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ This page discusses the following:
2020
- [Workflow Task](#workflow-task)
2121
- [When are Workflow Tasks scheduled?](#when-workflow-tasks-scheduled)
2222
- [How does a Worker process a Workflow Task?](#how-worker-processes-workflow-task)
23-
- [How does the SDK know which code to run?](#how-sdk-knows-code)
24-
- [Workflow Tasks and Determinism](#workflow-tasks-determinism)
25-
- [Performance characteristics](#workflow-task-performance)
23+
- [How does the SDK know which code to run?](#how-worker-processes-workflow-task)
24+
- [Workflow Tasks and Determinism](#workflow-task-failures-vs-execution-failures)
25+
- [Performance characteristics](#workflow-task-execution)
2626
- [Workflow Task Execution](#workflow-task-execution)
2727
- [Workflow Task Failures vs Workflow Execution Failures](#workflow-task-failures-vs-execution-failures)
2828
- [Activity Task](#activity-task)

0 commit comments

Comments
 (0)