Skip to content

Commit 186db22

Browse files
committed
fix typos in develop-docs/ and source files
1 parent cbdfd33 commit 186db22

File tree

53 files changed

+90
-90
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+90
-90
lines changed

app/[[...path]]/page.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ export async function generateMetadata(props: MetadataProps): Promise<Metadata>
199199
const domain = isDeveloperDocs
200200
? 'https://develop.sentry.dev'
201201
: 'https://docs.sentry.io';
202-
// enable og iamge preview on preview deployments
202+
// enable og image preview on preview deployments
203203
const previewDomain = process.env.VERCEL_URL
204204
? `https://${process.env.VERCEL_URL}`
205205
: domain;

develop-docs/application-architecture/multi-region-deployment/cross-region-rpc.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Service classes act as stubs that define the interface a service will have. In t
5959
- `local_mode` defines which silo mode this service uses it’s ‘local implementation’. Services can have local implementations in either silo mode.
6060
- `get_local_implementation` is used by the RPC machinery to find the implementation service when the silo mode matches or is `MONOLITH`.
6161

62-
RPC methods like `get_org_by_slug` must be defined as `abstractmethod` and must have either `rpc_method` or `regional_rpc_method` applied. If a method has `local_mode = REGION` it should use `regional_rpc_method` with a resolve ‘resolver’. There are several resolvers that accomodate a variety of method call signatures:
62+
RPC methods like `get_org_by_slug` must be defined as `abstractmethod` and must have either `rpc_method` or `regional_rpc_method` applied. If a method has `local_mode = REGION` it should use `regional_rpc_method` with a resolve ‘resolver’. There are several resolvers that accommodate a variety of method call signatures:
6363

6464
- `ByOrganizationSlug` will extract the `organization_slug` parameter and use it to locate the region using `sentry_organizationmapping`.
6565
- `ByOrganizationId` will extract the `organization_id` parameter and use it to locate the organization’s region using `sentry_organizationmapping`

develop-docs/application-architecture/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ This graph is extremely simplified mostly due to layout constraints. Missing fro
4040
* How Relay fetches project configs. Answer: from sentry-web
4141
* How Relay caches project configs. Answer: In memory, and in Redis
4242
* How Relay counts events and keeps track of quotas. Answer: more Redis
43-
* Symbolicator as auxilliary service to symbolicate-event
43+
* Symbolicator as auxiliary service to symbolicate-event
4444
* How alerting is triggered. Answer: postprocess-event, a Celery task which is responsible for alerting (spawned by a Kafka consumer in Sentry reading from eventstream)
4545
* Possibly more
4646

develop-docs/backend/api/design.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Design Principles
33
sidebar_order: 2
44
---
55

6-
This document contains a set of design principles and requirements whish should be applied to all Sentry APIs. These are _requirements_ when designing public APIs (such as Sentry's Web API), but internal APIs (such as an an internal service that Sentry communicates with) should attempt to adhere to these principles as well where it makes sense.
6+
This document contains a set of design principles and requirements which should be applied to all Sentry APIs. These are _requirements_ when designing public APIs (such as Sentry's Web API), but internal APIs (such as an an internal service that Sentry communicates with) should attempt to adhere to these principles as well where it makes sense.
77

88
In the Sentry monolith, we use [Django REST framework](https://www.django-rest-framework.org/) (DRF).
99

develop-docs/backend/api/serializers.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ class ModelSerializer(Serializer):
163163

164164
**get_attrs Method**
165165

166-
Why do this when Django Rest Framework has similar functionality? The `get_attrs` method is the reason. It allows you to do a bulk query versus multiple queries. In our example, instead of calling `ExampleTypes.objects.get(...)` multiple items, I can filter for the ones I want and assign them to the item in question using python. In the case of `attr` dictionary, the `key` is the item iteself. and the `value` is a dictionary with the name of the attribute you want to add and it's values.
166+
Why do this when Django Rest Framework has similar functionality? The `get_attrs` method is the reason. It allows you to do a bulk query versus multiple queries. In our example, instead of calling `ExampleTypes.objects.get(...)` multiple items, I can filter for the ones I want and assign them to the item in question using python. In the case of `attr` dictionary, the `key` is the item itself. and the `value` is a dictionary with the name of the attribute you want to add and it's values.
167167

168168
```python
169169
attrs[item] = {'attribute_name': attribute}

develop-docs/backend/application-domains/feature-flags/flagpole.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,11 +84,11 @@ Flagpole currently supports the following `operator` types:
8484

8585
`contains`
8686

87-
: Given a single int, string, float, or boolean value, evalutes to `True` if the context property value is a list containing the provided value.
87+
: Given a single int, string, float, or boolean value, evaluates to `True` if the context property value is a list containing the provided value.
8888

8989
`not_contains`
9090

91-
: The inverse of `contains`, evalutes to `True` if the context property value is a list which does not contain the provided value.
91+
: The inverse of `contains`, evaluates to `True` if the context property value is a list which does not contain the provided value.
9292

9393
`equals`
9494

@@ -114,7 +114,7 @@ Here are some common properties we surface via our Sentry and GetSentry context
114114

115115
`sentry_region` [str]
116116

117-
: The sentry region or single-tenant the flag check is being perfomed in.
117+
: The sentry region or single-tenant the flag check is being performed in.
118118

119119
`sentry_singletenant` [bool]
120120

develop-docs/backend/application-domains/grouping.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ which can be customized [on the client](https://docs.sentry.io/platforms/python/
88
and on the server via [fingerprint rules](https://docs.sentry.io/product/data-management-settings/event-grouping/fingerprint-rules/)
99
and [stack trace rules](https://docs.sentry.io/product/data-management-settings/event-grouping/stack-trace-rules/).
1010

11-
This documentation attemps to explain how the system currently functions and what limitations exist presently with it.
11+
This documentation attempts to explain how the system currently functions and what limitations exist presently with it.
1212

1313
# Basics
1414

@@ -192,8 +192,8 @@ The following general paths forward are current envisioned:
192192

193193
The consequences of making too many groups today are alert spam and the inability to work with multiple
194194
issues at once. If Sentry were to no longer be alerting on all new groups and tools existed to work
195-
across multiple groups more opportunies arise. In particular the grouping algorithm could continue to
196-
just fingerprint the stack trace but a secondary process could come in peridically and sweep up related
195+
across multiple groups more opportunities arise. In particular the grouping algorithm could continue to
196+
just fingerprint the stack trace but a secondary process could come in periodically and sweep up related
197197
fingerprints into a larger group. If we take the `get_current_user` example the creation of 50 independent
198198
groups is not much of an issue if no alerts are fired. If after 5 minute the system detected that they are
199199
in fact all very related (eg: the bug is "in `get_current_user`") it could leave the 50 generated groups

develop-docs/backend/application-domains/nodestore.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,4 @@ If you have a favorite data storage solution, it only has to operate under a few
2626
- get key
2727
- delete key
2828

29-
For more information on implementating your own backend, take a look at `sentry.nodestore.base.NodeStorage`.
29+
For more information on implementing your own backend, take a look at `sentry.nodestore.base.NodeStorage`.

develop-docs/backend/application-domains/pii/selectors.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ Select known parts of the schema using the following:
102102
[Remove] [Anything] from [$frame.vars]
103103
```
104104

105-
### Escaping Specal Characters
105+
### Escaping Special Characters
106106

107107
If the object key you want to match contains whitespace or special characters,
108108
you can use quotes to escape it:

develop-docs/development-infrastructure/analytics.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -308,11 +308,11 @@ If your analytics aren't showing up after you added it, you can't find an event
308308
- Check Amplitude for blocked events: In Amplitude, go to the "Data" section in the sidebar. From there, navigate to "Events" and search for your event name. It will show up with status "Blocked" if blocked, which means events won't show up. Some events may be blocked in favor of automatic route or button analytics.
309309
- For route analytics, confirm that the analytic event isn't being blocked with `useDisableRouteAnalytics`. Some components already had an analytic event so the route analytics were disabled.
310310
- Check the types of the data you are sending. Arrays aren't recommended data types to send (they can be hard to query and produce some unexpected behavior). Try to remove those if you are using them.
311-
- Remember there will always be some discrepency. Ad-blockers, for example, can block events from being sent. This could be a cause of why some numbers aren't adding up.
311+
- Remember there will always be some discrepancy. Ad-blockers, for example, can block events from being sent. This could be a cause of why some numbers aren't adding up.
312312
313313
## Metrics
314314
315-
Track aggregrate stats with [Metrics](/backend/metrics/). For example, this can be used to track aggregate response codes for an endpoint.
315+
Track aggregate stats with [Metrics](/backend/metrics/). For example, this can be used to track aggregate response codes for an endpoint.
316316
317317
Import the metrics library and use the `metrics.inc` function. The key needs to be unique.
318318

0 commit comments

Comments
 (0)