From a268deb38dcac7e23ed79fb9dd36ea44a6e2eb3f Mon Sep 17 00:00:00 2001 From: HazA Date: Tue, 4 Sep 2018 14:32:18 +0200 Subject: [PATCH] fix: Typos and minor stuff --- .../_documentation/learn/config-intro/electron.md | 2 +- .../_documentation/learn/configuration.md | 15 ++++++--------- .../learn/getting-started-config/electron.md | 4 ++-- .../learn/getting-started-install/rust.md | 2 +- .../_documentation/learn/quickstart.md | 6 +++--- .../_documentation/learn/set-release/electron.md | 2 +- 6 files changed, 14 insertions(+), 17 deletions(-) diff --git a/src/collections/_documentation/learn/config-intro/electron.md b/src/collections/_documentation/learn/config-intro/electron.md index 1f57a8856bee0..4836c02699521 100644 --- a/src/collections/_documentation/learn/config-intro/electron.md +++ b/src/collections/_documentation/learn/config-intro/electron.md @@ -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___', diff --git a/src/collections/_documentation/learn/configuration.md b/src/collections/_documentation/learn/configuration.md index 81abd8ac9ec89..f2124288c445c 100644 --- a/src/collections/_documentation/learn/configuration.md +++ b/src/collections/_documentation/learn/configuration.md @@ -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. @@ -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} @@ -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} diff --git a/src/collections/_documentation/learn/getting-started-config/electron.md b/src/collections/_documentation/learn/getting-started-config/electron.md index 97de4b1c4e61d..f17dd827e21bf 100644 --- a/src/collections/_documentation/learn/getting-started-config/electron.md +++ b/src/collections/_documentation/learn/getting-started-config/electron.md @@ -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___'}); ``` diff --git a/src/collections/_documentation/learn/getting-started-install/rust.md b/src/collections/_documentation/learn/getting-started-install/rust.md index 2f0d50c9f8f67..885521257f7b1 100644 --- a/src/collections/_documentation/learn/getting-started-install/rust.md +++ b/src/collections/_documentation/learn/getting-started-install/rust.md @@ -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] diff --git a/src/collections/_documentation/learn/quickstart.md b/src/collections/_documentation/learn/quickstart.md index 77b31ccfb1c1c..81ea0cc68ea9a 100644 --- a/src/collections/_documentation/learn/quickstart.md +++ b/src/collections/_documentation/learn/quickstart.md @@ -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' %} @@ -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' %} diff --git a/src/collections/_documentation/learn/set-release/electron.md b/src/collections/_documentation/learn/set-release/electron.md index 04bca6c162414..fdb638b53aec2 100644 --- a/src/collections/_documentation/learn/set-release/electron.md +++ b/src/collections/_documentation/learn/set-release/electron.md @@ -1,5 +1,5 @@ ```javascript -import * as sentry from '@sentry/electron'; +import * as Sentry from '@sentry/electron'; Sentry.init({ release: "{{ page.release_identifier }}",