3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-30 17:37:09 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs(v2): Update deployment.mdx (#3950)

Browse source 
Include documentation on environment variable needed for Enterprise GitHub Pages deployment.
This commit is contained in:
samhrncir 2020-12-28 04:35:03 -05:00 • committed by GitHub
parent b5c46bd1d9
commit b54ec93c61
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

6
website/docs/deployment.mdx
View file

@ -92,6 +92,12 @@ Optional parameters, also set as environment variables:
| `CURRENT_BRANCH` | The branch that contains the latest docs changes that will be deployed. Usually, the branch will be `master`, but it could be any branch (default or otherwise) except for `gh-pages`. If nothing is set for this variable, then the current branch will be used. |
| `GIT_PASS` | Password (or token) of the `git` user (specified by `GIT_USER`). For example, to facilitate non-interactive deployment (e.g. continuous deployment) |
GitHub enterprise installations should work in the same manner as github.com; you only need to set the organization's GitHub Enterprise host as an environment veriable:
| Name | Description |
| --- | --- |
| `GITHUB_HOST` | The domain name of your GitHub enterprise site. |
### Deploy
Finally, to deploy your site to GitHub Pages, run: