Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add release documentation #490

Merged
merged 7 commits into from
Jun 13, 2018
Merged

Add release documentation #490

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
70dc7d7
add releasing docs
May 11, 2018
e6bd185
add link to README
May 11, 2018
9024c20
minor edits
May 11, 2018
722a7a5
change link anchor in readme
May 14, 2018
3c49f4f
changes to updating the styleguide
May 14, 2018
4d671ff
add staff only to releasing documentation
May 14, 2018
450c58c
a few more tweaks to releasing docs
May 14, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ $ npm run build

## Releasing
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add something indicating releasing is only something Staff can do, or is that obvious enough?


You can find docs about our release process [here](./RELEASING.md).
You can find docs about our release process in [RELEASING.md](./RELEASING.md).

## Documentation

Expand Down
8 changes: 5 additions & 3 deletions RELEASING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,13 @@

#### Update the Style Guide

1. In [github/styleguide](https://github.com/github/styleguide), Update `primer` to your newly released version.
1. In [github/styleguide](https://github.com/github/styleguide), update `primer` to your newly released version in your terminal:

2. In your command line run: `script/update-primer-docs`.
`npm install primer@latest`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This renders a little funkily:

image

For consistency, it's probably best to just inline it rather than turning it into a full-on code block with triple backticks.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh weird! It's only using single backticks but maybe the spacing is off 🤔

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I think it's un-indented because it's on a new line and not indented 4 spaces.


3. Make PR, get it approved, merge! 🚀
2. Then run: `script/update-primer-docs`.

3. Commit changes, make PR, get it approved, merge! 🚀

#### Update [primer.github.io](primer.github.io)

Expand Down