Skip to content

Commit

Permalink
fix: Typos and minor stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
HazAT committed Sep 4, 2018
1 parent eb9a407 commit a268deb
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 17 deletions.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Options are passed to the `init()` as object:

```javascript
import * as sentry from '@sentry/electron';
import * as Sentry from '@sentry/electron';

Sentry.init({
dsn: '___PUBLIC_DSN___',
Expand Down
15 changes: 6 additions & 9 deletions src/collections/_documentation/learn/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,12 +66,12 @@ are always attached to exceptions but when this is set stacktraces are also sent
It's important to note that grouping in Sentry is different for events with stacktraces and without.
This means that you will get new groups as you enable or disable this flag for certain events.

This feature is off by default.
This feature is `off` by default.

{:.config-key}
### send-default-pii

If this flag, is enabled then certain personally identifiable information is added by active
If this flag is enabled, certain personally identifiable information is added by active
integrations. Without this flag they are never added to the event, to begin with. If possible
it's recommended to turn on this feature and use the server side PII stripping to remove the
values instead.
Expand All @@ -90,18 +90,15 @@ will attempt to auto-discover this value.
### blacklist-urls

{% supported browser %}
A pattern for error URLs which should not be sent to Sentry. To whitelist certain errors instead,
use `whitelist-urls`. By default, all errors will be sent. This only applies to events sent
from browsers.
A pattern for error URLs which should not be sent to Sentry. By default, all errors will be sent.
{% endsupported %}

{:.config-key}
### whitelist-urls

{% supported browser %}
A pattern for error URLs which should exclusively be sent to Sentry. To
blacklist certain errors instead, use `blacklist-urls`. By default, all errors
will be sent. This only applies to events sent from browsers.
A pattern for error URLs which should exclusively be sent to Sentry. By default, all errors
will be sent.
{% endsupported %}

{:.config-key}
Expand Down Expand Up @@ -165,7 +162,7 @@ scope. When nothing is returned from the function the breadcrumb is dropped.

## Transport Options

Transports are used to send events to sentry. This can be customized to some degree to better
Transports are used to send events to Sentry. This can be customized to some degree to better
support highly specific deployments.

{:.config-key}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@ You need to inform the sentry electron SDK about your CDN somewhere before
application startup:

```javascript
import * as sentry from '@sentry/electron';
sentry.init({dsn: '___PUBLIC_DSN___'});
import * as Sentry from '@sentry/electron';
Sentry.init({dsn: '___PUBLIC_DSN___'});
```
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
To add sentry to your Rust project you just need to add a new dependency to your `Cargo.toml`:
To add Sentry to your Rust project you just need to add a new dependency to your `Cargo.toml`:

```toml
[dependencies]
Expand Down
6 changes: 3 additions & 3 deletions src/collections/_documentation/learn/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ Getting started with Sentry is a three step process:
2. [Install your SDK](#pick-a-client-integration)
2. [Configure it](#configure-the-sdk)

## Configure an SDK {#pick-a-client-integration}
## Install a SDK {#pick-a-client-integration}

Sentry captures data by using an SDK within your application’s runtime. These are platform specific, and allow Sentry to have a deep understanding of both how your application works. In case your environment is very specific, you can also roll your own SDK using our document [_SDK API_]({%- link _documentation/clientdev/index.md -%}).
Sentry captures data by using a SDK within your application’s runtime. These are platform specific and allow Sentry to have a deep understanding of both how your application works. In case your environment is very specific, you can also roll your own SDK using our document [_SDK API_]({%- link _documentation/clientdev/index.md -%}).

{% include components/platform_content.html content_dir='getting-started-install' %}

Expand All @@ -30,7 +30,7 @@ Your platform is not listed? There are more SDKs we support: [list of SDKs]({%-

## Configure the SDK {#configure-the-sdk}

After you complete setting up a project in Sentry, you’ll be given a value which we call a _DSN_, or _Data Source Name_. It looks a lot like a standard URL, but it’s actually just a representation of the configuration required by the Sentry SDKs. It consists of a few pieces, including the protocol, public key, the server address, and the project identifier.
After you completed setting up a project in Sentry, you’ll be given a value which we call a _DSN_, or _Data Source Name_. It looks a lot like a standard URL, but it’s actually just a representation of the configuration required by the Sentry SDKs. It consists of a few pieces, including the protocol, public key, the server address, and the project identifier.

{% include components/platform_content.html content_dir='getting-started-config' %}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
```javascript
import * as sentry from '@sentry/electron';
import * as Sentry from '@sentry/electron';

Sentry.init({
release: "{{ page.release_identifier }}",
Expand Down

0 comments on commit a268deb

Please sign in to comment.