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

Jump to bottom

72 document fact that master pushes auto-update doc site #73

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

72 document fact that master pushes auto-update doc site #73

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 5 additions & 1 deletion docs/guides/publishing.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ After changes have been made to `master`, `next` should be rebased on `master`.
> - Pull Request passes all the things
> - Use Github to merge Pull Request

Note that upon merging to master, the docs site will be not be available until the build finishes.

## How to Publish

The library publishes to [npmjs.com](https://www.npmjs.com/package/@versionone/components). Login is required, either with the VersionOne account or with an existing account that is linked to our org.
Expand Down Expand Up @@ -69,7 +71,9 @@ A deployment preview of the docs site gets published on every Pull Request as we

> You can find a link to the build site in the Pull Request details (upon successfully passing all tests)

However, to publish a new release of the site, instead of a preview deployment, you'll need to follow these steps:
In addition, the docs site is updated automatically every time a Pull Request is merged to master. Note that the site will be unavailable while master is building.

If you want to publish a new release of the site manually, instead of a preview deployment, you'll need to follow these steps:

1. Log into [netlify](https://www.netlify.com/).
2. Navigate to the `versionone-components` project
Expand Down