{
    "componentChunkName": "component---packages-gatsby-theme-docs-src-templates-page-content-js",
    "path": "/writing/release-notes",
    "result": {"data":{"contentPage":{"title":"Release notes","globalNotification":null,"websitePrimaryColor":"#808080","beta":false,"isGlobalBeta":false,"excludeFromSearchIndex":true,"allowWideContentLayout":true,"body":"var _excluded = [\"components\"];\n\nfunction _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/* @jsxRuntime classic */\n\n/* @jsx mdx */\nvar _frontmatter = {\n  \"title\": \"Release notes\",\n  \"wideLayout\": true\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 Info = makeShortcode(\"Info\");\nvar layoutProps = {\n  _frontmatter: _frontmatter\n};\nvar MDXLayout = \"wrapper\";\nreturn function MDXContent(_ref) {\n  var components = _ref.components,\n      props = _objectWithoutProperties(_ref, _excluded);\n\n  return mdx(MDXLayout, _extends({}, layoutProps, props, {\n    components: components,\n    mdxType: \"MDXLayout\"\n  }), mdx(\"section\", {\n    \"id\": \"section-setting-up-the-release-notes-feature\",\n    \"className\": \"section-h2\"\n  }, mdx(\"h1\", {\n    parentName: \"section\",\n    \"id\": \"setting-up-the-release-notes-feature\"\n  }, \"Setting up the release notes feature\"), mdx(\"p\", {\n    parentName: \"section\"\n  }, \"The release notes feature is toggled by creating a conventionally named file \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"src/content/releases.mdx\"), \".\\nThe file is written like a regular content page. The docs-kit is automatically generating the release notes list below the content of that file and is applying a custom layout with filters for finding release notes.\"), mdx(\"p\", {\n    parentName: \"section\"\n  }, \"See the \", mdx(\"a\", {\n    parentName: \"p\",\n    \"href\": \"/documentation/../docs-smoke-test/releases\"\n  }, \"test site\"), \" for an example.\")), mdx(\"section\", {\n    \"id\": \"section-creating-a-new-release-note\",\n    \"className\": \"section-h2\"\n  }, mdx(\"h1\", {\n    parentName: \"section\",\n    \"id\": \"creating-a-new-release-note\"\n  }, \"Creating a new release note\"), mdx(\"p\", {\n    parentName: \"section\"\n  }, \"Release note files can be found in \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"src/content/releases\"), \" and are written in MDX like regular content. You can also place files in folders to better organize the release notes.\"), mdx(Info, {\n    mdxType: \"Info\"\n  }, \"The docs-kit provides an interactive command-line script to create new release notes.\", mdx(\"p\", {\n    parentName: \"section\"\n  }, \"  Calling \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"yarn create-docs-release-note\"), \" in the terminal guides through the creation\")), mdx(\"p\", {\n    parentName: \"section\"\n  }, \"The files' location does not imply the URL like for content.\\nThe URL is built from the frontmatter fields for date and title.\\nThis way you can reorganize the files without changing the URL of the release note.\"), mdx(\"p\", {\n    parentName: \"section\"\n  }, \"To learn the full release note file format including the full specification of the frontmatter fields, see the \", mdx(\"a\", {\n    parentName: \"p\",\n    \"href\": \"/documentation/../docs-smoke-test/releases/2000-03-03-release-note-format-definition-custom\"\n  }, \"specification by example file\"), \".\")), mdx(\"section\", {\n    \"id\": \"section-template\",\n    \"className\": \"section-h2\"\n  }, mdx(\"h1\", {\n    parentName: \"section\",\n    \"id\": \"template\"\n  }, \"Template\"), mdx(\"p\", {\n    parentName: \"section\"\n  }, \"When not using the CLI tool to create a release note, you can use this template:\"), mdx(\"pre\", {\n    parentName: \"section\"\n  }, mdx(\"code\", {\n    parentName: \"pre\",\n    \"className\": \"language-markdown\"\n  }, \"---\\ndate: 2020-01-01\\ntitle: (TEMPLATE) TITLE\\ndescription: | # title content and what this is good for //  max 256 characters // for MC, RSS and other feeds\\n  (TEMPLATE) DESCRIPTION\\ntype: enhancement # feature | fix | enhancement | announcement\\ntopics:\\n# uncomment matching topics. Stay focused.\\n#  - Products\\n#  - Product List\\n#  - Categories\\n#  - Carts\\n#  - API Clients\\n#  - Settings\\n---\\n\\nFooBar Intro Line: What this is good for (like description)\\n\\n * [API] FooBar\\n\\n<!--more-->\\n\\nA longer explanation here that is just shown on the details page.\\nIf there is no more, remove the marker above, too.\\n\"))));\n}\n;\nMDXContent.isMDXComponent = true;","tableOfContents":{"items":[{"title":"Setting up the release notes feature","url":"#setting-up-the-release-notes-feature"},{"title":"Creating a new release note","url":"#creating-a-new-release-note"},{"title":"Template","url":"#template"}]},"navLevels":3,"showTimeToRead":false,"timeToRead":0,"estimatedTimeToRead":1}},"pageContext":{"slug":"/writing/release-notes","shortTitle":"Release notes","hasReleaseNotes":false}},
    "staticQueryHashes": ["2494036674","3227520225","3295477089","3359654165","3845541775","636942989"]}