From da297714372a76f43f8aa92a864c1c642f0d0996 Mon Sep 17 00:00:00 2001 From: David Cramer Date: Wed, 30 Sep 2020 12:10:44 -0700 Subject: [PATCH 1/2] feat: Improve Product Guides structure - Expose dropdown for Product navigation - Move all product pages into /product/ - Re-order sidebar to push relevant (vs marketing/discovery) docs to the top --- src/api/permissions.mdx | 4 +- src/components/navbar.tsx | 10 ++-- src/components/navbarProductDropdown.tsx | 45 ++++++++++++++++++ src/components/sidebar.tsx | 23 +++++++-- src/docs/cli/index.mdx | 40 ---------------- src/docs/clients/javascript/sourcemaps.mdx | 2 +- src/docs/clients/react-native/codepush.mdx | 2 +- src/docs/enriching-error-data/breadcrumbs.mdx | 35 -------------- src/docs/product/accounts/index.mdx | 6 +++ .../accounts/membership-toggle.png | Bin .../{ => product}/accounts/membership.mdx | 0 src/docs/{ => product}/accounts/pricing.mdx | 4 +- .../{ => product}/accounts/quotas/index.mdx | 18 +++---- .../quotas/manage-event-stream-01.png | Bin .../quotas/manage-event-stream-02.png | Bin .../quotas/manage-event-stream-03.png | Bin .../quotas/manage-event-stream-04.png | Bin .../quotas/manage-event-stream-05.png | Bin .../quotas/manage-event-stream-06.png | Bin .../quotas/manage-event-stream-07.png | Bin .../quotas/manage-event-stream-08.png | Bin .../quotas/manage-event-stream-09.png | Bin .../quotas/manage-event-stream-10.png | Bin .../quotas/manage-event-stream-11.png | Bin .../quotas/manage-event-stream-12.png | Bin .../quotas/manage-event-stream-13.png | Bin .../quotas/manage-event-stream-14.png | Bin .../quotas/manage-event-stream-15.png | Bin .../quotas/manage-event-stream-16.png | Bin .../quotas/manage-event-stream-17.png | Bin .../quotas/manage-event-stream-guide.mdx | 6 +-- .../accounts/quotas/spike-email.jpg | Bin .../accounts/require-2fa-add-auth.png | Bin .../accounts/require-2fa-audit-log.png | Bin .../accounts/require-2fa-email.png | Bin .../accounts/require-2fa-members.png | Bin .../accounts/require-2fa-rejoin.png | Bin .../accounts/require-2fa-resend-invite.png | Bin .../accounts/require-2fa-switch.png | Bin .../{ => product}/accounts/require-2fa.mdx | 0 .../sso/azure-basic-saml-configuration.png | Bin ...azure-map-identity-provider-attributes.png | Bin .../sso/azure-saml-signing-certificate.png | Bin .../accounts/sso/azure-sentry-overview.png | Bin .../{ => product}/accounts/sso/azure-sso.mdx | 0 src/docs/{ => product}/accounts/sso/index.mdx | 2 +- .../accounts/sso/saml2-map-attributes.png | Bin .../accounts/sso/saml2-metadata-url.png | Bin .../accounts/sso/saml2-provider-data.png | Bin .../accounts/sso/saml2-provider-xml.png | Bin .../accounts/sso/saml2-success.png | Bin src/docs/{ => product}/accounts/sso/saml2.mdx | 0 .../accounts/user-settings/index.mdx | 0 .../accounts/user-settings/us-2fact.png | Bin .../accounts/user-settings/us-alert.png | Bin .../accounts/user-settings/us-apps.png | Bin .../accounts/user-settings/us-avatar.png | Bin .../accounts/user-settings/us-close.png | Bin .../accounts/user-settings/us-deploy.png | Bin .../accounts/user-settings/us-epanellink.png | Bin .../accounts/user-settings/us-eprime.png | Bin .../accounts/user-settings/us-ereport.png | Bin .../accounts/user-settings/us-eroute.png | Bin .../accounts/user-settings/us-id.png | Bin .../accounts/user-settings/us-lang.png | Bin .../accounts/user-settings/us-myact.png | Bin .../accounts/user-settings/us-name.png | Bin .../accounts/user-settings/us-npanellink.png | Bin .../accounts/user-settings/us-pass.png | Bin .../accounts/user-settings/us-rec.png | Bin .../accounts/user-settings/us-sess.png | Bin .../accounts/user-settings/us-shistory.png | Bin .../accounts/user-settings/us-sto.png | Bin .../accounts/user-settings/us-subs.png | Bin .../accounts/user-settings/us-time.png | Bin .../accounts/user-settings/us-token.png | Bin .../accounts/user-settings/us-work.png | Bin .../accounts/user-settings/us-wrfield.png | Bin .../product/alerts-notifications/alerts.mdx | 2 +- src/docs/{ => product}/cli/configuration.mdx | 0 src/docs/{ => product}/cli/dif.mdx | 6 +-- src/docs/product/cli/index.mdx | 41 ++++++++++++++++ src/docs/{ => product}/cli/installation.mdx | 0 src/docs/{ => product}/cli/releases.mdx | 2 +- src/docs/{ => product}/cli/send-event.mdx | 0 .../integrations/azure-devops/index.mdx | 2 +- .../product/integrations/bitbucket/index.mdx | 14 +++--- .../product/integrations/github/index.mdx | 8 ++-- .../product/integrations/gitlab/index.mdx | 4 +- src/docs/product/integrations/index.mdx | 37 +++++++------- src/docs/product/integrations/jira/index.mdx | 6 +-- .../performance/distributed-tracing.mdx | 2 +- src/docs/product/relay/getting-started.mdx | 18 +++---- src/docs/product/relay/index.mdx | 2 +- src/docs/product/releases/index.mdx | 8 ++-- .../release-automation/circleci/index.mdx | 2 +- .../release-automation/jenkins/index.mdx | 2 +- .../release-automation/travis-ci/index.mdx | 2 +- src/docs/{meta => product/security}/index.md | 10 ++-- .../{meta => product/security}/ip-ranges.mdx | 0 .../security}/legal-and-compliance.png | Bin src/docs/{meta => product/security}/soc2.md | 0 src/docs/{meta => product/security}/ssl.mdx | 0 src/docs/{meta => product/security}/terms.md | 0 .../sentry-basics/guides/discover/index.mdx | 4 +- .../guides/getting-started/index.mdx | 8 ++-- .../configuration-options.mdx | 2 +- .../integrate-backend/getting-started.mdx | 4 +- .../integrate-frontend/upload-source-maps.mdx | 2 +- src/pages/index.tsx | 4 +- src/platforms/android/index.mdx | 6 +-- src/platforms/apple/common/dsym.mdx | 2 +- .../common/configuration/filtering.mdx | 2 +- .../common/configuration/options.mdx | 2 +- .../common/data-management/debug-files.mdx | 10 ++-- .../enriching-events/attachments/index.mdx | 2 +- .../common/sourcemaps/hosting-publicly.mdx | 2 +- .../javascript/common/sourcemaps/index.mdx | 4 +- .../common/sourcemaps/tools/webpack.mdx | 2 +- .../common/sourcemaps/uploading.mdx | 2 +- .../common/sourcemaps/validating.mdx | 2 +- .../javascript/guides/electron/index.mdx | 2 +- .../javascript/guides/react/index.mdx | 2 +- src/platforms/react-native/codepush.mdx | 2 +- vercel.json | 12 +++++ 125 files changed, 243 insertions(+), 200 deletions(-) create mode 100644 src/components/navbarProductDropdown.tsx delete mode 100644 src/docs/cli/index.mdx delete mode 100644 src/docs/enriching-error-data/breadcrumbs.mdx create mode 100644 src/docs/product/accounts/index.mdx rename src/docs/{ => product}/accounts/membership-toggle.png (100%) rename src/docs/{ => product}/accounts/membership.mdx (100%) rename src/docs/{ => product}/accounts/pricing.mdx (97%) rename src/docs/{ => product}/accounts/quotas/index.mdx (93%) rename src/docs/{ => product}/accounts/quotas/manage-event-stream-01.png (100%) rename src/docs/{ => product}/accounts/quotas/manage-event-stream-02.png (100%) rename src/docs/{ => product}/accounts/quotas/manage-event-stream-03.png (100%) rename src/docs/{ => product}/accounts/quotas/manage-event-stream-04.png (100%) rename src/docs/{ => product}/accounts/quotas/manage-event-stream-05.png (100%) rename src/docs/{ => product}/accounts/quotas/manage-event-stream-06.png (100%) rename src/docs/{ => product}/accounts/quotas/manage-event-stream-07.png (100%) rename src/docs/{ => product}/accounts/quotas/manage-event-stream-08.png (100%) rename src/docs/{ => product}/accounts/quotas/manage-event-stream-09.png (100%) rename src/docs/{ => product}/accounts/quotas/manage-event-stream-10.png (100%) rename src/docs/{ => product}/accounts/quotas/manage-event-stream-11.png (100%) rename src/docs/{ => product}/accounts/quotas/manage-event-stream-12.png (100%) rename src/docs/{ => product}/accounts/quotas/manage-event-stream-13.png (100%) rename src/docs/{ => product}/accounts/quotas/manage-event-stream-14.png (100%) rename src/docs/{ => product}/accounts/quotas/manage-event-stream-15.png (100%) rename src/docs/{ => product}/accounts/quotas/manage-event-stream-16.png (100%) rename src/docs/{ => product}/accounts/quotas/manage-event-stream-17.png (100%) rename src/docs/{ => product}/accounts/quotas/manage-event-stream-guide.mdx (97%) rename src/docs/{ => product}/accounts/quotas/spike-email.jpg (100%) rename src/docs/{ => product}/accounts/require-2fa-add-auth.png (100%) rename src/docs/{ => product}/accounts/require-2fa-audit-log.png (100%) rename src/docs/{ => product}/accounts/require-2fa-email.png (100%) rename src/docs/{ => product}/accounts/require-2fa-members.png (100%) rename src/docs/{ => product}/accounts/require-2fa-rejoin.png (100%) rename src/docs/{ => product}/accounts/require-2fa-resend-invite.png (100%) rename src/docs/{ => product}/accounts/require-2fa-switch.png (100%) rename src/docs/{ => product}/accounts/require-2fa.mdx (100%) rename src/docs/{ => product}/accounts/sso/azure-basic-saml-configuration.png (100%) rename src/docs/{ => product}/accounts/sso/azure-map-identity-provider-attributes.png (100%) rename src/docs/{ => product}/accounts/sso/azure-saml-signing-certificate.png (100%) rename src/docs/{ => product}/accounts/sso/azure-sentry-overview.png (100%) rename src/docs/{ => product}/accounts/sso/azure-sso.mdx (100%) rename src/docs/{ => product}/accounts/sso/index.mdx (98%) rename src/docs/{ => product}/accounts/sso/saml2-map-attributes.png (100%) rename src/docs/{ => product}/accounts/sso/saml2-metadata-url.png (100%) rename src/docs/{ => product}/accounts/sso/saml2-provider-data.png (100%) rename src/docs/{ => product}/accounts/sso/saml2-provider-xml.png (100%) rename src/docs/{ => product}/accounts/sso/saml2-success.png (100%) rename src/docs/{ => product}/accounts/sso/saml2.mdx (100%) rename src/docs/{ => product}/accounts/user-settings/index.mdx (100%) rename src/docs/{ => product}/accounts/user-settings/us-2fact.png (100%) rename src/docs/{ => product}/accounts/user-settings/us-alert.png (100%) rename src/docs/{ => product}/accounts/user-settings/us-apps.png (100%) rename src/docs/{ => product}/accounts/user-settings/us-avatar.png (100%) rename src/docs/{ => product}/accounts/user-settings/us-close.png (100%) rename src/docs/{ => product}/accounts/user-settings/us-deploy.png (100%) rename src/docs/{ => product}/accounts/user-settings/us-epanellink.png (100%) rename src/docs/{ => product}/accounts/user-settings/us-eprime.png (100%) rename src/docs/{ => product}/accounts/user-settings/us-ereport.png (100%) rename src/docs/{ => product}/accounts/user-settings/us-eroute.png (100%) rename src/docs/{ => product}/accounts/user-settings/us-id.png (100%) rename src/docs/{ => product}/accounts/user-settings/us-lang.png (100%) rename src/docs/{ => product}/accounts/user-settings/us-myact.png (100%) rename src/docs/{ => product}/accounts/user-settings/us-name.png (100%) rename src/docs/{ => product}/accounts/user-settings/us-npanellink.png (100%) rename src/docs/{ => product}/accounts/user-settings/us-pass.png (100%) rename src/docs/{ => product}/accounts/user-settings/us-rec.png (100%) rename src/docs/{ => product}/accounts/user-settings/us-sess.png (100%) rename src/docs/{ => product}/accounts/user-settings/us-shistory.png (100%) rename src/docs/{ => product}/accounts/user-settings/us-sto.png (100%) rename src/docs/{ => product}/accounts/user-settings/us-subs.png (100%) rename src/docs/{ => product}/accounts/user-settings/us-time.png (100%) rename src/docs/{ => product}/accounts/user-settings/us-token.png (100%) rename src/docs/{ => product}/accounts/user-settings/us-work.png (100%) rename src/docs/{ => product}/accounts/user-settings/us-wrfield.png (100%) rename src/docs/{ => product}/cli/configuration.mdx (100%) rename src/docs/{ => product}/cli/dif.mdx (97%) create mode 100644 src/docs/product/cli/index.mdx rename src/docs/{ => product}/cli/installation.mdx (100%) rename src/docs/{ => product}/cli/releases.mdx (99%) rename src/docs/{ => product}/cli/send-event.mdx (100%) rename src/docs/{meta => product/security}/index.md (66%) rename src/docs/{meta => product/security}/ip-ranges.mdx (100%) rename src/docs/{meta => product/security}/legal-and-compliance.png (100%) rename src/docs/{meta => product/security}/soc2.md (100%) rename src/docs/{meta => product/security}/ssl.mdx (100%) rename src/docs/{meta => product/security}/terms.md (100%) diff --git a/src/api/permissions.mdx b/src/api/permissions.mdx index 54cd24f6b376a9..58c606dcc53a4b 100644 --- a/src/api/permissions.mdx +++ b/src/api/permissions.mdx @@ -7,7 +7,7 @@ If you're building on top of Sentry's API (i.e using [Auth Tokens](/api/auth/)), different API endpoints. If you're looking for information on membership roles please visit the -[membership](/accounts/membership/) documentation. +[membership](/product/accounts/membership/) documentation. ### Organizations @@ -72,6 +72,6 @@ Events in sentry are immutable and can only be deleted by deleting the whole iss -Be aware that if you're using `sentry-cli` to [manage your releases](/cli/releases/), you'll need a token which also has `org:read` scope. +Be aware that if you're using `sentry-cli` to [manage your releases](/product/cli/releases/), you'll need a token which also has `org:read` scope. diff --git a/src/components/navbar.tsx b/src/components/navbar.tsx index 168b2c99049b4c..2e7ea7abcc4f63 100644 --- a/src/components/navbar.tsx +++ b/src/components/navbar.tsx @@ -7,6 +7,8 @@ import Search from "./search"; import SmartLink from "./smartLink"; import usePlatform, { usePlatformList } from "./hooks/usePlatform"; +import NavbarProductDropdown from "./navbarProductDropdown"; + type Props = { platforms?: string[]; }; @@ -21,11 +23,7 @@ export default ({ platforms }: Props): JSX.Element => { @@ -191,7 +191,7 @@ const IndexPage = () => {
  • - + Organization and User Management
    • diff --git a/src/platforms/android/index.mdx b/src/platforms/android/index.mdx index b58e0f45916afd..16158bd1d77183 100644 --- a/src/platforms/android/index.mdx +++ b/src/platforms/android/index.mdx @@ -184,7 +184,7 @@ public class DemoClass { ## ProGuard -To use ProGuard with Sentry, upload the ProGuard mapping files by using our Gradle integration (**recommended**) or manually by using [sentry-cli](/cli/dif/#proguard-mapping-upload). +To use ProGuard with Sentry, upload the ProGuard mapping files by using our Gradle integration (**recommended**) or manually by using [sentry-cli](/product/cli/dif/#proguard-mapping-upload). ### Gradle Integration @@ -211,7 +211,7 @@ buildscript { The plugin will automatically generate appropriate ProGuard mapping files and upload them when you run `gradle assemble{BuildVariant}`. For example, `assembleRelease` — Release is the default, but the plugin works for others if you have enabled ProGuard/R8. The credentials for the upload step are loaded via environment variables or from a `sentry.properties` file in your project root. -For more information, see the [full sentry-cli documentation](/cli/configuration/#configuration-values). +For more information, see the [full sentry-cli documentation](/product/cli/configuration/#configuration-values). At the very minimum you will need something like this: @@ -221,7 +221,7 @@ defaults.org=your-org auth.token=YOUR_AUTH_TOKEN ``` -You can find your authentication token [on the Sentry API page](https://sentry.io/api/). For more information about the available configuration options, see the [full sentry-cli documentation](/cli/configuration/#configuration-values). +You can find your authentication token [on the Sentry API page](https://sentry.io/api/). For more information about the available configuration options, see the [full sentry-cli documentation](/product/cli/configuration/#configuration-values). ### Gradle Configuration diff --git a/src/platforms/apple/common/dsym.mdx b/src/platforms/apple/common/dsym.mdx index 78171afd35fc02..851889698edc88 100644 --- a/src/platforms/apple/common/dsym.mdx +++ b/src/platforms/apple/common/dsym.mdx @@ -95,7 +95,7 @@ Your project’s dSYM can be upload during the build phase as a “Run Script” You need to have an Auth Token for this to work. You can [create an Auth Token here](https://sentry.io/api/). -1. Download and install [sentry-cli](https://github.com/getsentry/sentry-cli#installation) +1. Download and install [sentry-cli](/product/cli/installation/) 2. You will need to copy the script below into a new _Run Script_ and set your _AUTH_TOKEN_, _ORG_SLUG_, and _PROJECT_SLUG_ ```bash diff --git a/src/platforms/common/configuration/filtering.mdx b/src/platforms/common/configuration/filtering.mdx index 60f16df611f1ca..1f055a164b60dc 100644 --- a/src/platforms/common/configuration/filtering.mdx +++ b/src/platforms/common/configuration/filtering.mdx @@ -44,7 +44,7 @@ When you enable sampling in your SDK, you choose a percentage of collected error -For Sentry's Performance Monitoring, we recommend sampling your data for two reasons. First, though capturing a single trace involves minimal overhead, capturing traces for every single page load, or every single API request, has the potential to add an undesirable amount of load to your system. Second, by enabling sampling you’ll more easily prevent yourself from exceeding your organization’s [event quota](/accounts/quotas/). +For Sentry's Performance Monitoring, we recommend sampling your data for two reasons. First, though capturing a single trace involves minimal overhead, capturing traces for every single page load, or every single API request, has the potential to add an undesirable amount of load to your system. Second, by enabling sampling you’ll more easily prevent yourself from exceeding your organization’s [event quota](/product/accounts/quotas/). When choosing a sampling rate, the goal is not to collect *too* much data, but to collect sufficient data so you can draw meaningful conclusions. If you’re not sure what rate to choose, start with a low value and gradually increase it as you learn more about your traffic patterns and volume, until you’ve found a rate that balances performance and cost concerns with data accuracy. diff --git a/src/platforms/common/configuration/options.mdx b/src/platforms/common/configuration/options.mdx index e53654d59d7fe8..f085c879d4b879 100644 --- a/src/platforms/common/configuration/options.mdx +++ b/src/platforms/common/configuration/options.mdx @@ -11,7 +11,7 @@ initialized. ## Common Options -The list of common options across SDKs. These work more or less the same in all SDKs, but some subtle differences will exist to better support the platform. Options that can be read from an environment variable or your `~/.sentryclirc` file (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) are read automatically. See [Working with Projects](/cli/configuration/#sentry-cli-working-with-projects) for more information. +The list of common options across SDKs. These work more or less the same in all SDKs, but some subtle differences will exist to better support the platform. Options that can be read from an environment variable or your `~/.sentryclirc` file (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) are read automatically. See [Working with Projects](/product/cli/configuration/#sentry-cli-working-with-projects) for more information. diff --git a/src/platforms/common/data-management/debug-files.mdx b/src/platforms/common/data-management/debug-files.mdx index 3a7b1308530386..9f18072d9e37ed 100644 --- a/src/platforms/common/data-management/debug-files.mdx +++ b/src/platforms/common/data-management/debug-files.mdx @@ -31,7 +31,7 @@ the following formats: Source maps, while also being debug information files, are handled -in Sentry. For more information see [Source Maps in sentry-cli](/cli/releases/#sentry-cli-sourcemaps). +in Sentry. For more information see [Source Maps in sentry-cli](/product/cli/releases/#sentry-cli-sourcemaps). differently @@ -82,7 +82,7 @@ Sentry might not need all of the above information to process crash reports. Still, it is always a good idea to provide all available debug information. `sentry-cli` can be used to list properties of supported debug files and -validate their contents. See [_Debug Information Files in sentry-cli_](/cli/dif/) for more information. +validate their contents. See [_Debug Information Files in sentry-cli_](/product/cli/dif/) for more information. The remainder of this section describes the file formats in detail. @@ -254,7 +254,7 @@ their debug identifiers. You can copy this identifier and search for the exact files that match it in the _Debug Files_ settings screen. `sentry-cli` can help to print properties of debug information files like their -debug identifier. See [_Checking Debug Information Files_](/cli/dif/#checking-files) for more information. +debug identifier. See [_Checking Debug Information Files_](/product/cli/dif/#checking-files) for more information. ### GNU Build Identifiers @@ -340,7 +340,7 @@ $ sentry-cli upload-dif -o -p /path/to/files ``` For all available options and more information refer to [_Uploading Debug -Information_](/cli/dif/#uploading-files). +Information_](/product/cli/dif/#uploading-files). Always ensure that debug files are uploaded before deploying or releasing your application so that crash reports can be processed. For manual testing, use the @@ -644,7 +644,7 @@ unobfuscated source code at runtime. To get source context for native applications, source code needs to be uploaded alongside the debug information files. The recommended way to do this is by -using `sentry-cli`. See [Creating Source Bundles](/cli/dif/#creating-source-bundles) for more information. +using `sentry-cli`. See [Creating Source Bundles](/product/cli/dif/#creating-source-bundles) for more information. Source bundles show up as regular debug files on the _Debug Files_ settings page. They are designated as "source bundle" and feature a `sources` tag. To diff --git a/src/platforms/common/enriching-events/attachments/index.mdx b/src/platforms/common/enriching-events/attachments/index.mdx index eb062bf092d42c..e8d95cd5692554 100644 --- a/src/platforms/common/enriching-events/attachments/index.mdx +++ b/src/platforms/common/enriching-events/attachments/index.mdx @@ -40,7 +40,7 @@ Usually, native crash reports range from a few kilobytes to a few megabytes. Thi Attachments persist for 30 days; if your total storage included in your quota is exceeded, attachments will not be stored. You can delete attachments or their containing events at any time. Deleting an attachment does not affect your quota - Sentry counts an attachment toward your quota as soon as it is stored. -Learn more about how attachments impact your [quota](/accounts/quotas/). +Learn more about how attachments impact your [quota](/product/accounts/quotas/). diff --git a/src/platforms/javascript/common/sourcemaps/hosting-publicly.mdx b/src/platforms/javascript/common/sourcemaps/hosting-publicly.mdx index 6ace7c6007f2c1..6bc4db62f523f3 100644 --- a/src/platforms/javascript/common/sourcemaps/hosting-publicly.mdx +++ b/src/platforms/javascript/common/sourcemaps/hosting-publicly.mdx @@ -34,7 +34,7 @@ For these reasons, it is best practice to upload source maps to Sentry beforehan ## Working Behind a Firewall -While the recommended solution is to upload your source artifacts to Sentry, sometimes it’s necessary to allow communication from Sentry’s internal IPs. For more information on Sentry’s public IPs see: [IP Ranges](/meta/ip-ranges/). +While the recommended solution is to upload your source artifacts to Sentry, sometimes it’s necessary to allow communication from Sentry’s internal IPs. For more information on Sentry’s public IPs see: [IP Ranges](/product/security/ip-ranges/). ## Secure Access to Source Maps diff --git a/src/platforms/javascript/common/sourcemaps/index.mdx b/src/platforms/javascript/common/sourcemaps/index.mdx index ff5551c84907a5..edf85b2c7c9564 100644 --- a/src/platforms/javascript/common/sourcemaps/index.mdx +++ b/src/platforms/javascript/common/sourcemaps/index.mdx @@ -46,7 +46,7 @@ The Releases -> Admin permission is also known as 'project:releases' in other AP -You may configure [sentry-cli](/cli/configuration/) through it's documented mechanisms, or instead simply bind required parameters when initializing the plugin: +You may configure [sentry-cli](/product/cli/configuration/) through it's documented mechanisms, or instead simply bind required parameters when initializing the plugin: ```javascript {filename:webpack.config.js} const SentryWebpackPlugin = require("@sentry/webpack-plugin"); @@ -100,7 +100,7 @@ From here, you can [upload your source maps](uploading/) to Sentry. ## Additional Resources -- [Using sentry-cli to Upload Source Maps](/cli/releases/#sentry-cli-sourcemaps) +- [Using sentry-cli to Upload Source Maps](/product/cli/releases/#sentry-cli-sourcemaps) - [Debuggable JavaScript with Source Maps](https://blog.sentry.io/2015/10/29/debuggable-javascript-with-source-maps.html) - [4 Reasons Why Your Source Maps Are Broken](https://blog.sentry.io/2018/10/18/4-reasons-why-your-source-maps-are-broken) - [Debug Your Node.js Projects with Source Maps](https://blog.sentry.io/2019/02/20/debug-node-source-maps) diff --git a/src/platforms/javascript/common/sourcemaps/tools/webpack.mdx b/src/platforms/javascript/common/sourcemaps/tools/webpack.mdx index 09bfe92bc50259..4d71ca7a47f845 100644 --- a/src/platforms/javascript/common/sourcemaps/tools/webpack.mdx +++ b/src/platforms/javascript/common/sourcemaps/tools/webpack.mdx @@ -15,7 +15,7 @@ $ npm install --save-dev @sentry/webpack-plugin $ yarn add --dev @sentry/webpack-plugin ``` -You may configure [sentry-cli](/cli/configuration/) through it's documented mechanisms, or instead simply bind required parameters when initializing the plugin: +You may configure [sentry-cli](/product/cli/configuration/) through it's documented mechanisms, or instead simply bind required parameters when initializing the plugin: ```javascript {filename:webpack.config.js} const SentryWebpackPlugin = require("@sentry/webpack-plugin"); diff --git a/src/platforms/javascript/common/sourcemaps/uploading.mdx b/src/platforms/javascript/common/sourcemaps/uploading.mdx index b6e1d5024620c3..bae9f5f6e88091 100644 --- a/src/platforms/javascript/common/sourcemaps/uploading.mdx +++ b/src/platforms/javascript/common/sourcemaps/uploading.mdx @@ -6,7 +6,7 @@ We recommend uploading source maps as part of your build process, but you can al -The recommended way to upload source maps is using [sentry-cli](/cli/). If you have used [_Sentry Wizard_](https://github.com/getsentry/sentry-wizard) to set up your project, it has already created all necessary configuration to upload source maps. Otherwise, follow the [CLI configuration docs](/cli/configuration/) to set up your project. +The recommended way to upload source maps is using [sentry-cli](/product/cli/). If you have used [_Sentry Wizard_](https://github.com/getsentry/sentry-wizard) to set up your project, it has already created all necessary configuration to upload source maps. Otherwise, follow the [CLI configuration docs](/product/cli/configuration/) to set up your project. diff --git a/src/platforms/javascript/common/sourcemaps/validating.mdx b/src/platforms/javascript/common/sourcemaps/validating.mdx index bf78130ff4ef32..6ac2d9931f662e 100644 --- a/src/platforms/javascript/common/sourcemaps/validating.mdx +++ b/src/platforms/javascript/common/sourcemaps/validating.mdx @@ -4,7 +4,7 @@ title: Validating Files It can be quite challenging to ensure that source maps are actually valid themselves and uploaded correctly. To help with this, we maintain an online validation tool that can be used to test your source maps against your **hosted** source: [sourcemaps.io](https://sourcemaps.io). -Additionally, you can use the `--validate` flag within when uploading source maps with [sentry-cli](/cli/), which will attempt to locally parse the source map and look up the references. Note that there are known cases where the validate flag will indicate failures when the setup is correct (if you have references to external source maps, then the validation tool will indicate a failure). +Additionally, you can use the `--validate` flag within when uploading source maps with [sentry-cli](/product/cli/), which will attempt to locally parse the source map and look up the references. Note that there are known cases where the validate flag will indicate failures when the setup is correct (if you have references to external source maps, then the validation tool will indicate a failure). You can also check these, in addition to the validation step: diff --git a/src/platforms/javascript/guides/electron/index.mdx b/src/platforms/javascript/guides/electron/index.mdx index 847c91b9539897..7e0227359f9eb3 100644 --- a/src/platforms/javascript/guides/electron/index.mdx +++ b/src/platforms/javascript/guides/electron/index.mdx @@ -183,7 +183,7 @@ If your application contains custom native extensions or you wish to symbolicate crashes from a spawned child process, upload their debug information manually during your build or release process. See [_Debug Information Files_](/workflow/debug-files/) for a detailed description of how to set up Sentry for native development. Additionally, see [_Uploading Debug -Information_](/cli/dif/) for the upload process. +Information_](/product/cli/dif/) for the upload process. ### Child Processes diff --git a/src/platforms/javascript/guides/react/index.mdx b/src/platforms/javascript/guides/react/index.mdx index 7a6f784a6e9d6b..bb7d1c57f27c88 100644 --- a/src/platforms/javascript/guides/react/index.mdx +++ b/src/platforms/javascript/guides/react/index.mdx @@ -119,7 +119,7 @@ We **highly recommend** you incorporate source maps to receive the full benefit When you’re using the Sentry React SDK, the SDK automatically fetches the source code and source maps by scraping the URLs within the stack trace. If you need to disable the JavaScript source fetching, log in to Sentry and toggle off `Allow JavaScript source fetching` in your organization's settings for Security & Privacy. See our [source maps documentation](/platforms/javascript/guides/react/sourcemaps/) to learn more. -Upload source maps using either our [Webpack plugin](/platforms/javascript/guides/react/sourcemaps/tools/webpack/) or the [Sentry CLI](/cli/). Sourcemaps can be generated by [Uglify JS](/platforms/javascript/guides/react/sourcemaps/tools/uglifyjs/), [System JS](/platforms/javascript/guides/react/sourcemaps/tools/systemjs/), or [TypeScript](/platforms/javascript/guides/react/sourcemaps/tools/typescript/). +Upload source maps using either our [Webpack plugin](/platforms/javascript/guides/react/sourcemaps/tools/webpack/) or the [Sentry CLI](/product/cli/). Sourcemaps can be generated by [Uglify JS](/platforms/javascript/guides/react/sourcemaps/tools/uglifyjs/), [System JS](/platforms/javascript/guides/react/sourcemaps/tools/systemjs/), or [TypeScript](/platforms/javascript/guides/react/sourcemaps/tools/typescript/). ## Monitor Performance diff --git a/src/platforms/react-native/codepush.mdx b/src/platforms/react-native/codepush.mdx index 22348f55432ba7..251448afd2cddd 100644 --- a/src/platforms/react-native/codepush.mdx +++ b/src/platforms/react-native/codepush.mdx @@ -46,7 +46,7 @@ When making the release with CodePush, make sure to output the bundle and source $ appcenter codepush release-react -a {APP} -d {DEPLOYMENT} --sourcemap-output --output-dir ./build ``` -Exporting the `SENTRY_PROPERTIES` will tell sentry-cli to use the properties in your project. The sentry-wizard install step should have generated this file for you. Alternatively, you can either pass it via parameters or a global settings file. To find more about this refer to [Working with Projects](/cli/configuration/#sentry-cli-working-with-projects). +Exporting the `SENTRY_PROPERTIES` will tell sentry-cli to use the properties in your project. The sentry-wizard install step should have generated this file for you. Alternatively, you can either pass it via parameters or a global settings file. To find more about this refer to [Working with Projects](/product/cli/configuration/#sentry-cli-working-with-projects). ```bash $ export SENTRY_PROPERTIES=./ios/sentry.properties diff --git a/vercel.json b/vercel.json index 44ba2f7b13ed5d..a17338c2dce893 100644 --- a/vercel.json +++ b/vercel.json @@ -24,6 +24,18 @@ ], "trailingSlash": true, "redirects": [ + { + "source": "/meta/(.*)", + "destination": "/product/security/$1" + }, + { + "source": "/cli/(.*)", + "destination": "/product/cli/$1" + }, + { + "source": "/accounts/(.*)", + "destination": "/product/accounts/$1" + }, { "source": "/(hosted|on-premise)/(.*)", "destination": "/$2" }, { "source": "/internal/(.*)", "destination": "https://develop.sentry.dev" }, { From b5a04b9a7271abf60c2a9050bef2210444fd1c0a Mon Sep 17 00:00:00 2001 From: David Cramer Date: Wed, 30 Sep 2020 13:19:19 -0700 Subject: [PATCH 2/2] fix links --- src/docs/product/relay/getting-started.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/docs/product/relay/getting-started.mdx b/src/docs/product/relay/getting-started.mdx index 451f562b407eea..6331774e95c9b4 100644 --- a/src/docs/product/relay/getting-started.mdx +++ b/src/docs/product/relay/getting-started.mdx @@ -188,7 +188,7 @@ Under default configuration, Relay emits log output similar to: INFO relay_server::actors::upstream > relay successfully registered with upstream ``` -Refer to the [Logging](/product/relay/monitoring/#logging) page for more information on how to configure Relay's logging. +Refer to the [Logging](../monitoring/#logging) page for more information on how to configure Relay's logging. If you moved your config folder (for example, for security reasons), use the `--config` option to specify the location: @@ -226,7 +226,7 @@ and host of the DSN to:

    Use the new DSN in your SDK configuration. To test this, you can send a message -with `sentry-cli` ([installation instructions](/cli/installation/)): +with `sentry-cli` ([installation instructions](/product/cli/installation/)): ```shell export SENTRY_DSN='http://12345abcdef10111213141516171819@127.0.0.1:3000/2345' @@ -238,6 +238,6 @@ project. ## Next Steps -- **[Learn more about our Operating Guidelines](/product/relay/operating-guidelines/)** +- **[Learn more about our Operating Guidelines](../operating-guidelines/)** With a working Relay instance, you can both monitor and scale your Relay setup.