-
Notifications
You must be signed in to change notification settings - Fork 593
Contributing to the Site
Changes are automatically deployed when they are merged into the master
branch. We use a release branch to collect doc PRs that can't be pushed until the next release.
The following instructions assume that you have already installed all of the required software.
Content goes live when it is merged into the master
branch. About fifteen minutes after it's merged, it's live on developer.okta.com (deployed via CI).
-
Fetch latest from origin and create a new topic branch off of
master
:[okta-developer-docs branch]$ git checkout master [okta-developer-docs master]$ git fetch origin [okta-developer-docs master]$ git merge origin/master [okta-developer-docs master]$ git checkout -b my-branch
-
Make your changes inside the
packages/@okta/vuepress-site/
directory. -
Confirm that VuePress builds a local version of the site by running
yarn dev
and then navigating to http://localhost:8080/docs/. Check your changes. -
After you are happy with your changes, commit them, push the branch.
[okta-developer-docs branch]$ git push -u origin my-branch
-
Create a new Pull Request. Leave the base branch as
master
. If your update is related to a monolith release (i.e. it should not go out until a specific version of Monolith is released) then mark it with the "docs release" Label in GitHub. -
Get your PR reviewed. If you are a developer updating an API Reference page, have someone else from your team approve your PR. All PRs should also tag the
okta/developerdocs
team as a Reviewer.
If anything goes awry with publication, contact Developer Platform EEP.