Merge pull request #635 from primer/docs-releases

docs: Releases link, Status key page move

Author: shawnbot

docs/lib/changelog.js

@@ -3,7 +3,6 @@ const filter = require('metalsmith-filter')
 const frontmatter = require('metalsmith-matters')
 const watch = require('metalsmith-watch')
 
-const addChangelog = require('./changelog')
 const addPackageMeta = require('./add-package-meta')
 const {extractPackages, writePackagesJSON} = require('./extract-packages-json')
 const addSource = require('./add-source')
@@ -57,12 +56,6 @@ module.exports = function sync(options = {}) {
     )
     // rename files with their "path" frontmatter key
     .use(rename(file => file[ns] ? `${file[ns].path}.md` : true), {log})
-    // read the changelog manually
-    .use(addChangelog('../CHANGELOG.md', 'whats-new/changelog.md', file => {
-      file[ns] = {
-        title: 'Changelog'
-      }
-    }))
     .use((_files, metal, done) => {
       files = _files
       done()

docs/lib/sync.js

@@ -6,7 +6,7 @@ import {BaseStyles, BorderBox, Box, Flex, theme} from '@primer/components'
 import {injectGlobal} from 'emotion'
 import {Header, PackageHeader, SideNav} from '../src/components'
 import getComponents from '../src/markdown'
-import {requirePage, rootPage} from '../src/utils'
+import {config, requirePage, rootPage} from '../src/utils'
 import {CONTENT_MAX_WIDTH} from '../src/constants'
 
 import 'primer/index.scss'
@@ -75,10 +75,12 @@ export default class MyApp extends App {
                   <MDXProvider components={components}>
                     <Component {...page} />
                   </MDXProvider>
-                  <details>
-                    <summary>Metadata</summary>
-                    <pre>meta: {JSON.stringify(meta, null, 2)}</pre>
-                  </details>
+                  {config.production ? null : (
+                    <details>
+                      <summary>Metadata</summary>
+                      <pre>{JSON.stringify(meta, null, 2)}</pre>
+                    </details>
+                  )}
                 </div>
                 {/* TODO: bring back edit link! */}
               </Box>

docs/pages/_app.js

@@ -41,4 +41,3 @@ utilities/marketing-padding.md
 utilities/marketing-type.md
 utilities/padding.md
 utilities/typography.md
-whats-new/changelog.md

docs/pages/css/.gitignore

@@ -0,0 +1,15 @@
+---
+title: Status key
+---
+
+import StatusLabel from '../../src/StatusLabel'
+
+Primer is constantly evolving and we have many styles to refactor and bring up to standard. The status of each package is shown with it's corresponding documentation so you can be confident which styles are safe to use.
+
+| Label | Description |
+| :----- | :--- |
+| <StatusLabel id="stable" status="Stable" /> | These styles are safe to use in production and there are currently no planned updates. If you find a problem with these styles please [open and issue](https://github.com/github/design-systems/issues). |
+| <StatusLabel id="new-release" status="New release" /> | These are newly shipped styles that are safe to use in production. While these styles will have been thoroughly tested before being shipped you may find room for improvements in the documentation, and it's possible you may find the occasional bug. Like all the code we ship, the best test is when lots of people start using it. We'll link to a corresponding feedback issue for new releases so you can comment if you find any problems or have questions. |
+| <StatusLabel id="experimental" status="Experimental" /> | These styles are a work in progress that are safe to use, but haven't been battle-tested yet. That means they may go through more significant changes in the near future. You can use these styles and help us test out these styles while we're working on, them as long as you are prepared for changes (though we'll handle updates as much as possible for you). We will have a corresponding issue for experimental styles where you can let us know you're using them, and can leave feedback or ask questions. |
+| <StatusLabel id="in-review" status="In review" /> | This means we are actively reviewing these styles with a view to refactor or deprecate them. They are still safe to use in production but if you are considering using them on a new feature it would be good to talk to us so we can make sure that our review doesn't disrupt your work. All styles in review will have a corresponding issue explaining why they are in review and will link to any relevant pull requests. |
+| <StatusLabel id="deprecated" status="Deprecated" /> | These styles are in the process of being removed and should no longer be used in production. The design systems team are responsible for updating existing views that currently use these styles, however you can help us by replacing deprecated classes from views that you are working on (if you have the time). You will get a lint error telling you to replace these styles if you attempt to add new instances. Please contact us if this causes you a problem. |