Skip to content

Commit 1f273da

Browse files
Apply suggestions from code review version 6
Co-authored-by: Liza Mock <[email protected]>
1 parent c5f42a7 commit 1f273da

File tree

2 files changed

+24
-24
lines changed

2 files changed

+24
-24
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Migration Guide
33
sidebar_order: 8000
4-
description: "Learn about migrating to new Sentry React Native SDK versions."
4+
description: "Learn how to migrate to the new versions of Sentry's React Native SDK."
55
---
66

77
<PageGrid />

docs/platforms/react-native/migration/v5-to-v6.mdx

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
11
---
22
title: Migrate from 5.x to 6.x
33
sidebar_order: 100
4-
description: "Learn about migrating from the SDK version 5 to 6"
4+
description: "Learn how to migrate from version 5 to version 6 of the Sentry React Native SDK"
55
---
66

7-
The main goal of Sentry React Native SDK version 6 is bring compatibility with Sentry JavaScript version 8 and to improve our performance monitoring APIs and integrations. This version is breaking because of the JavaScript SDK dependency upgrade to version 8 and becuase we removed deprecated APIs, restructured npm package contents.
7+
The main goal of version 6 of the Sentry React Native SDK, is to bring compatibility with Sentry JavaScript version 8 and to improve our performance monitoring APIs and integrations. This version is breaking because of the JavaScript SDK dependency upgrade to version 8 and because we've removed deprecated APIs and restructured npm package contents.
88

9-
## Important changes in dependencies
9+
## Important Changes In Dependencies
1010

1111
The Sentry React Native SDK ships with the Sentry JavaScript SDK as a dependency. The Sentry JavaScript SDK has been updated to version 8. This version includes a number of breaking changes. Please follow the JavaScript migration guides to complete the upgrade.
1212

13-
The initial `@sentry/[email protected]` ships with `@sentry/[email protected]`. Always use the exact JavaScript SDK version, if adding it manually to your project, any other version might not be compatible with the React Native SDK.
13+
The initial `@sentry/[email protected]` ships with `@sentry/[email protected]`. Always use the exact JavaScript SDK version if adding it manually to your project. Any other version might not be compatible with the React Native SDK.
1414

15-
### Performance Monitoring API changes
15+
### Performance-Monitoring API Changes
1616

17-
The main focus of the Sentry JavaScript SDK version 8 is to improve our performance monitoring APIs and that's why the Tracing APIs changes are desccribed in a standalone guide. Please follow the [Tracing API changes](/platforms/javascript/migration/v7-to-v8/v8-new-performance-api/) guide to complete the upgrade.
17+
The main focus of the Sentry JavaScript SDK version 8, is to improve our performance monitoring APIs. That's why the Tracing API changes are described in a standalone guide. Please follow the [Tracing API changes](/platforms/javascript/migration/v7-to-v8/v8-new-performance-api/) guide to complete the upgrade.
1818

19-
### General API changes
19+
### General API Changes
2020

2121
Other general JavaScript SDK version 8 changes are described in the [JavaScript SDK 7.x to 8.x migration guide](/platforms/javascript/migration/v7-to-v8/).
2222

23-
## Important React Native SDK `6.x` changes
23+
## Important React Native SDK `6.x` Changes
2424

25-
This section describes the APIs changes in the Sentry React Native SDK version 6.
25+
This section describes API changes in the Sentry React Native SDK, version 6.
2626

27-
### React Native Tracing options moved to `Sentry.init` options
27+
### React Native Tracing Options Moved to `Sentry.init` Options
2828

29-
To change the follwoing options, you no longer need to create instance of React Native Tracing. Instead, you can pass them directly to `Sentry.init` options.
29+
To change the following options, you no longer need to create an instance of React Native Tracing. Instead, you can pass them directly to `Sentry.init` options.
3030

3131
```javascript diff
3232
import * as Sentry from '@sentry/react-native';
@@ -46,9 +46,9 @@ Sentry.init({
4646
});
4747
```
4848

49-
### Navigation Instrumentations are now standalone integrations
49+
### Navigation Instrumentations Are Now Standalone Integrations
5050

51-
The Navigation Instrumentations are now a standalone integrations and you need to add it to the `integrations` array in the `Sentry.init` options.
51+
Navigation Instrumentations are now standalone integrations. You'll need to add it to the `integrations` array in the `Sentry.init` options.
5252

5353
```javascript {tabTitle:Expo Router} diff
5454
import Sentry from '@sentry/react-native';
@@ -101,13 +101,13 @@ Sentry.init({
101101
});
102102
```
103103

104-
### React Navigation version 4 is not supported
104+
### React Navigation Version 4 Is Not Supported
105105

106-
`ReactNavigationV4Instrumentation` was removed in the SDK version 6. If you are using React Navigation version 4, you need to upgrade to version 5 or never.
106+
`ReactNavigationV4Instrumentation` was removed in version 6 of the SDK. If you're using React Navigation version 4, you'll need to upgrade to version 5 or newer.
107107

108-
### RoutingInstrumentation for Custom Navigation was removed
108+
### RoutingInstrumentation for Custom Navigation Was Removed
109109

110-
`RoutingInstrumentation` was removed in the SDK version 6. If you are using custom navigation, use `startIdleNavigationSpan` fucntion.
110+
`RoutingInstrumentation` was removed in version 6 of the SDK. If you're using custom navigation, use the `startIdleNavigationSpan` function.
111111

112112
```javascript {tabTitle:Direct} diff
113113
- const routingInstrumentation = new Sentry.RoutingInstrumentation();
@@ -176,9 +176,9 @@ Sentry.init({
176176
});
177177
```
178178
179-
### `beforeNavigate` replaced by `beforeStartSpan`
179+
### `beforeNavigate` Replaced by `beforeStartSpan`
180180
181-
The `beforeNavigate` option was removed in the SDK version 6. Use the `beforeStartSpan` option instead. The `beforeStartSpan` option is a function that is called before starting a navigation span. This function can't stop the span from being started, but it can modify the span start options before it starts.
181+
The `beforeNavigate` option was removed in version 6 of the SDK . Use the `beforeStartSpan` option instead. The `beforeStartSpan` option is a function that's called before starting a navigation span. This function can't stop the span from being started, but it can modify the span start options before it starts.
182182
183183
```javascript diff
184184
Sentry.init({
@@ -198,9 +198,9 @@ Sentry.init({
198198
});
199199
```
200200
201-
### `enableSpotlight` and `spotlightSidecarUrl` replaced by `spotlight`
201+
### `enableSpotlight` and `spotlightSidecarUrl` Replaced by `spotlight`
202202
203-
The `enableSpotlight` and `spotlightSidecarUrl` options were removed in the SDK version 6. Use the `spotlight` option instead.
203+
The `enableSpotlight` and `spotlightSidecarUrl` options were removed in version 6 of the SDK. Use the `spotlight` option instead.
204204
205205
```javascript diff
206206
import * as Sentry from '@sentry/react-native';
@@ -213,9 +213,9 @@ Sentry.init({
213213
});
214214
```
215215
216-
### React Native Tracing `idleTimeout` and `maxTransactionDuration` options were removed
216+
### React Native Tracing `idleTimeout` and `maxTransactionDuration` Options Were Removed
217217
218-
The `idleTimeout` and `maxTransactionDuration` options were removed in the SDK version 6. Use the `idleTimeoutMs` and `finalTimeoutMs` options from the JavaScript SDK instead.
218+
The `idleTimeout` and `maxTransactionDuration` options were removed in version 6 of the SDK. Use the `idleTimeoutMs` and `finalTimeoutMs` options from the JavaScript SDK instead.
219219
220220
```javascript diff
221221
import * as Sentry from '@sentry/react-native';

0 commit comments

Comments
 (0)