Skip to content

Commit 0cc8af1

Browse files
authored
fix(tasks) Update headings to improve sidebar (#14938)
## DESCRIBE YOUR PR h1 headings are not included in the 'on this page' sidebar. Only h2 and lower are included in the page contents. ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. - [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE --> - [ ] Other deadline: <!-- ENTER DATE HERE --> - [x] None: Not urgent, can wait up to 1 week+ ## SLA - Teamwork makes the dream work, so please add a reviewer to your PRs. - Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it. Thanks in advance for your help! ## PRE-MERGE CHECKLIST *Make sure you've checked the following before merging your changes:* - [ ] Checked Vercel preview for correctness, including links - [x] PR was reviewed and approved by any necessary SMEs (subject matter experts) - [ ] PR was reviewed and approved by a member of the [Sentry docs team](https://github.com/orgs/getsentry/teams/docs)
1 parent b0b34d6 commit 0cc8af1

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

develop-docs/backend/application-domains/tasks/index.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ asynchronously in a background worker process. The task framework within Sentry
88
is inspired by [Celery](https://docs.celeryproject.org) as it was originally
99
built with celery.
1010

11-
# Defining Tasks
11+
## Defining Tasks
1212

1313
Sentry tasks are configured with the `instrumented_task` decorator that
1414
includes features like automatic tracing and metric collection, and multi-region
@@ -213,7 +213,7 @@ def deliver_issue_webhook(organization_id: int, group_id: int) -> None:
213213

214214
If an idempotent task exceeds a processing deadline, it will *not* be retried.
215215

216-
# Testing Tasks
216+
## Testing Tasks
217217

218218
Tasks can be tested with a few different approaches. The first is with the
219219
`self.tasks()` or `TaskRunner` context manager. When these context managers are
@@ -242,7 +242,7 @@ def test_schedule_task(self, mock_deliver: MagicMock) -> None:
242242
Mocking tasks will not validate that parameters are JSON compatible, nor will it catch TypeErrors from signature mismatches.
243243
</Alert>
244244

245-
# Task namespaces
245+
## Task namespaces
246246

247247
Task namespaces are created as code, and configuration are linked to the
248248
namespace when it is declared.
@@ -269,7 +269,7 @@ will be run in our `default` worker pools. If your task namespace will be
269269
high-throughput (more than 1500 tasks per second) consider provisioning
270270
a dedicated pool for your tasks.
271271

272-
# Periodically Scheduled Tasks
272+
## Periodically Scheduled Tasks
273273

274274
Task can also be set to spawn on a periodic schedule. To accomplish this, simply
275275
update the `TASKWORKER_SCHEDULE` configuration found in

develop-docs/backend/application-domains/tasks/terminology-and-concepts.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ deliver_issue_webhook.delay(organization_id=org.id, issue_id=issue.id)
2828
See [Defining Tasks](/backend/application-domains/tasks/#defining-tasks) for
2929
more information on defining tasks.
3030

31-
# Task Namespaces
31+
## Task Namespaces
3232

3333
Namespaces provide logical groupings of tasks by product domain or
3434
functionality. All task activations within a namespace are processed in order
@@ -79,7 +79,7 @@ namespace:ingest.profiling --> kr[kafka-replays]
7979
8080
```
8181

82-
# System Components
82+
## System Components
8383

8484
The task framework is composed of a few components:
8585

@@ -95,7 +95,7 @@ w -- publish result --> b
9595

9696
Client applications produce TaskActivation messages (serialized as protobuf messages) to Kafka topics. Taskbroker instances consume Kafka messages, and make activations available to workers via gRPC.
9797

98-
# Terminology
98+
## Terminology
9999

100100
- `Task` A function that can be scheduled to run later. Tasks are executed by workers, and can be retried should they fail.
101101
- `TaskNamespace` A collection of related tasks that are operated together. Activations within a namespace will be ordered, but activations between namespaces have no ordering promises.

0 commit comments

Comments
 (0)