瀏覽代碼

docs(sentry-plugin): Add sentry plugin to docs sidebar

Michael Bromley 2 年之前
父節點
當前提交
e3324b5e98
共有 2 個文件被更改,包括 11 次插入3 次删除
  1. 6 0
      docs/sidebars.js
  2. 5 3
      packages/sentry-plugin/src/sentry-plugin.ts

+ 6 - 0
docs/sidebars.js

@@ -267,6 +267,12 @@ const sidebars = {
                     link: { type: 'doc', id: 'reference/core-plugins/payments-plugin/index' },
                     items: [{ type: 'autogenerated', dirName: 'reference/core-plugins/payments-plugin' }],
                 },
+                {
+                    type: 'category',
+                    label: 'SentryPlugin',
+                    link: { type: 'doc', id: 'reference/core-plugins/sentry-plugin/index' },
+                    items: [{ type: 'autogenerated', dirName: 'reference/core-plugins/sentry-plugin' }],
+                },
                 {
                     type: 'category',
                     label: 'StellatePlugin',

+ 5 - 3
packages/sentry-plugin/src/sentry-plugin.ts

@@ -39,7 +39,7 @@ const SentryOptionsProvider = {
  * Install this plugin as well as the `@sentry/node` package:
  *
  * ```sh
- * npm install --save @vendure/sentry-plugin @sentry/node
+ * npm install --save \@vendure/sentry-plugin \@sentry/node
  * ```
  *
  * ## Configuration
@@ -60,7 +60,9 @@ const SentryOptionsProvider = {
  *             // Optional configuration
  *             includeErrorTestMutation: true,
  *             enableTracing: true,
- *             // you can also pass in any of the options from @sentry/node
+ *             // you can also pass in any of the options from \@sentry/node
+ *             // for instance:
+ *             tracesSampleRate: 1.0,
  *         }),
  *         // highlight-end
  *     ],
@@ -94,7 +96,7 @@ const SentryOptionsProvider = {
  * To test whether your Sentry configuration is working correctly, you can set the `includeErrorTestMutation` option to `true`. This will add a mutation to the Admin API
  * which will throw an error of the type specified in the `errorType` argument. For example:
  *
- * ```gql
+ * ```graphql
  * mutation CreateTestError {
  *     createTestError(errorType: DATABASE_ERROR)
  * }