{"componentChunkName":"component---src-templates-doc-tsx","path":"/contributing/onboarding-wizard/","result":{"data":{"file":{"id":"e363940c-65c8-5589-97dc-c200b70ccddc","relativePath":"contributing/onboarding-wizard.mdx","sourceInstanceName":"docs","childMarkdownRemark":null,"childMdx":{"body":"function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }\n\nfunction _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }\n\nfunction _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }\n\n/* @jsx mdx */\nvar _frontmatter = {\n  \"title\": \"Onboarding Wizard\",\n  \"noindex\": true,\n  \"sidebar_order\": 1000\n};\n\nvar makeShortcode = function makeShortcode(name) {\n  return function MDXDefaultShortcode(props) {\n    console.warn(\"Component \" + name + \" was not imported, exported, or provided by MDXProvider as global scope\");\n    return mdx(\"div\", props);\n  };\n};\n\nvar CodeTabs = makeShortcode(\"CodeTabs\");\nvar CodeBlock = makeShortcode(\"CodeBlock\");\nvar Note = makeShortcode(\"Note\");\nvar layoutProps = {\n  _frontmatter: _frontmatter\n};\nvar MDXLayout = \"wrapper\";\nreturn function MDXContent(_ref) {\n  var components = _ref.components,\n      props = _objectWithoutProperties(_ref, [\"components\"]);\n\n  return mdx(MDXLayout, _extends({}, layoutProps, props, {\n    components: components,\n    mdxType: \"MDXLayout\"\n  }), mdx(\"p\", null, \"The docs repository is responsible for a piece of functionality in the Sentry product most commonly referred to as \", mdx(\"em\", {\n    parentName: \"p\"\n  }, \"the Wizard\"), \". More precisely, the product pulls in documentation about SDK configuration in part of its project creation / onboarding process.\"), mdx(\"p\", null, \"The content for the onboarding wizard is located in \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"src/wizard\"), \", and follows slightly different rules than other pages:\"), mdx(\"ul\", null, mdx(\"li\", {\n    parentName: \"ul\"\n  }, \"It is markdown \", mdx(\"em\", {\n    parentName: \"li\"\n  }, \"only\"), \". MDX is not currently supported.\"), mdx(\"li\", {\n    parentName: \"ul\"\n  }, \"It is exported as plain HTML (encoded as JSON), thus styles need to exist within Sentry itself.\"), mdx(\"li\", {\n    parentName: \"ul\"\n  }, \"The exposed frontmatter is specific to the wizard.\")), mdx(\"h2\", {\n    \"id\": \"directory-structure\",\n    \"style\": {\n      \"position\": \"relative\"\n    }\n  }, mdx(\"a\", _extends({\n    parentName: \"h2\"\n  }, {\n    \"href\": \"#directory-structure\",\n    \"aria-label\": \"directory structure permalink\",\n    \"className\": \"anchor before\"\n  }), mdx(\"svg\", _extends({\n    parentName: \"a\"\n  }, {\n    \"viewBox\": \"0 0 24 24\",\n    \"xmlns\": \"http://www.w3.org/2000/svg\"\n  }), mdx(\"path\", _extends({\n    parentName: \"svg\"\n  }, {\n    \"d\": \"M10.879 6.05L15 1.93A5.001 5.001 0 0 1 22.071 9l-4.121 4.121a1 1 0 0 1-1.414-1.414l4.12-4.121a3 3 0 1 0-4.242-4.243l-4.121 4.121a1 1 0 1 1-1.414-1.414zm2.242 11.9L9 22.07A5 5 0 1 1 1.929 15l4.121-4.121a1 1 0 0 1 1.414 1.414l-4.12 4.121a3 3 0 1 0 4.242 4.243l4.121-4.121a1 1 0 1 1 1.414 1.414zm-8.364-.122l13.071-13.07a1 1 0 0 1 1.415 1.414L6.172 19.242a1 1 0 1 1-1.415-1.414z\",\n    \"fill\": \"currentColor\"\n  })))), \"Directory Structure\"), mdx(\"p\", null, \"The directory structure directly influences how content is exposed within onboarding. It takes the form of:\"), mdx(\"div\", {\n    \"className\": \"code-tabs-wrapper\"\n  }, mdx(CodeTabs, {\n    mdxType: \"CodeTabs\"\n  }, mdx(CodeBlock, {\n    language: \"bash\",\n    title: \"\",\n    filename: \"\",\n    mdxType: \"CodeBlock\"\n  }, mdx(\"div\", _extends({\n    parentName: \"div\"\n  }, {\n    \"className\": \"gatsby-highlight\",\n    \"data-language\": \"bash\"\n  }), mdx(\"pre\", _extends({\n    parentName: \"div\"\n  }, {\n    \"className\": \"language-bash\"\n  }), mdx(\"code\", _extends({\n    parentName: \"pre\"\n  }, {\n    \"className\": \"language-bash\"\n  }), \"src/wizard\\nsrc/wizard/\", mdx(\"span\", _extends({\n    parentName: \"code\"\n  }, {\n    \"className\": \"token punctuation\"\n  }), \"{\"), \"platform\", mdx(\"span\", _extends({\n    parentName: \"code\"\n  }, {\n    \"className\": \"token punctuation\"\n  }), \"}\"), \"/index.md\\nsrc/wizard/\", mdx(\"span\", _extends({\n    parentName: \"code\"\n  }, {\n    \"className\": \"token punctuation\"\n  }), \"{\"), \"platform\", mdx(\"span\", _extends({\n    parentName: \"code\"\n  }, {\n    \"className\": \"token punctuation\"\n  }), \"}\"), \"/\", mdx(\"span\", _extends({\n    parentName: \"code\"\n  }, {\n    \"className\": \"token punctuation\"\n  }), \"{\"), \"guide\", mdx(\"span\", _extends({\n    parentName: \"code\"\n  }, {\n    \"className\": \"token punctuation\"\n  }), \"}\"), \".md\")))))), mdx(\"p\", null, \"The \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"index.md\"), \" is exposed as the root platform instructions, and \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"{guide}.md\"), \" is exposed as a child integration of the platform. This functions similarly to the \", mdx(\"a\", _extends({\n    parentName: \"p\"\n  }, {\n    \"href\": \"../platforms\"\n  }), \"platform pages\"), \".\"), mdx(\"h2\", {\n    \"id\": \"page-format\",\n    \"style\": {\n      \"position\": \"relative\"\n    }\n  }, mdx(\"a\", _extends({\n    parentName: \"h2\"\n  }, {\n    \"href\": \"#page-format\",\n    \"aria-label\": \"page format permalink\",\n    \"className\": \"anchor before\"\n  }), mdx(\"svg\", _extends({\n    parentName: \"a\"\n  }, {\n    \"viewBox\": \"0 0 24 24\",\n    \"xmlns\": \"http://www.w3.org/2000/svg\"\n  }), mdx(\"path\", _extends({\n    parentName: \"svg\"\n  }, {\n    \"d\": \"M10.879 6.05L15 1.93A5.001 5.001 0 0 1 22.071 9l-4.121 4.121a1 1 0 0 1-1.414-1.414l4.12-4.121a3 3 0 1 0-4.242-4.243l-4.121 4.121a1 1 0 1 1-1.414-1.414zm2.242 11.9L9 22.07A5 5 0 1 1 1.929 15l4.121-4.121a1 1 0 0 1 1.414 1.414l-4.12 4.121a3 3 0 1 0 4.242 4.243l4.121-4.121a1 1 0 1 1 1.414 1.414zm-8.364-.122l13.071-13.07a1 1 0 0 1 1.415 1.414L6.172 19.242a1 1 0 1 1-1.415-1.414z\",\n    \"fill\": \"currentColor\"\n  })))), \"Page Format\"), mdx(\"p\", null, \"Each page consists of some wizard-specific frontmatter, as well as a markdown body:\"), mdx(\"div\", {\n    \"className\": \"code-tabs-wrapper\"\n  }, mdx(CodeTabs, {\n    mdxType: \"CodeTabs\"\n  }, mdx(CodeBlock, {\n    language: \"markdown\",\n    title: \"\",\n    filename: \"src/wizard/platform/index.md\",\n    mdxType: \"CodeBlock\"\n  }, mdx(\"div\", _extends({\n    parentName: \"div\"\n  }, {\n    \"className\": \"gatsby-highlight\",\n    \"data-language\": \"markdown\"\n  }), mdx(\"pre\", _extends({\n    parentName: \"div\"\n  }, {\n    \"className\": \"language-markdown\"\n  }), mdx(\"code\", _extends({\n    parentName: \"pre\"\n  }, {\n    \"className\": \"language-markdown\"\n  }), mdx(\"span\", _extends({\n    parentName: \"code\"\n  }, {\n    \"className\": \"token hr punctuation\"\n  }), \"---\"), \"\\nname: Platform Name\\ndoc_url: Permalink for this page\\ntype: framework\\n\", mdx(\"span\", _extends({\n    parentName: \"code\"\n  }, {\n    \"className\": \"token title important\"\n  }), \"support_level: production\\n\", mdx(\"span\", _extends({\n    parentName: \"span\"\n  }, {\n    \"className\": \"token punctuation\"\n  }), \"---\")), \"\\n\\nThis is my content.\")))))), mdx(Note, {\n    mdxType: \"Note\"\n  }, mdx(\"markdown\", null, mdx(\"p\", null, \"Wizard content is only supported with native markdown (not MDX), thus only with a \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \".md\"), \" extension.\"))));\n}\n;\nMDXContent.isMDXComponent = true;","tableOfContents":{"items":[{"url":"#directory-structure","title":"Directory Structure"},{"url":"#page-format","title":"Page Format"}]},"internal":{"type":"Mdx"}}}},"pageContext":{"excerpt":"The docs repository is responsible for a piece of functionality in the Sentry product most commonly referred to as  the Wizard . More precisely, the product pulls in documentation about SDK configuration in part of its project creation / onboarding process. The content for the onboarding wizard is located in  src/wizard , and follows slightly different rules than other pages: It is markdown  only . MDX is not currently supported. It is exported as plain HTML (encoded as JSON), thus styles need to exist within Sentry itself. The exposed frontmatter is specific to the wizard. Directory Structure The directory structure directly influences how content is exposed within onboarding. It takes the form of: The  index.md  is exposed as the root platform instructions, and  {guide}.md  is exposed as a child integration of the platform. This functions similarly to the  platform pages . Page Format Each page consists of some wizard-specific frontmatter, as well as a markdown body: Wizard content is only supported with native markdown (not MDX), thus only with a  .md  extension.","title":"Onboarding Wizard","description":null,"draft":null,"noindex":true,"notoc":null,"sidebar_order":1000,"redirect_from":null,"keywords":null,"id":"e363940c-65c8-5589-97dc-c200b70ccddc","legacy":false}},"staticQueryHashes":["1218203755","1222113826","1222113826","1766336459","2158593473","2764967025","3345802723","3818502851","3990806462","4015007367","4192517163","4264099332","518019976"]}