From b54ec93c61f0a176a79925d8cfab51d835ed630b Mon Sep 17 00:00:00 2001 From: samhrncir <46274278+samhrncir@users.noreply.github.com> Date: Mon, 28 Dec 2020 04:35:03 -0500 Subject: [PATCH] docs(v2): Update deployment.mdx (#3950) Include documentation on environment variable needed for Enterprise GitHub Pages deployment. --- website/docs/deployment.mdx | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/website/docs/deployment.mdx b/website/docs/deployment.mdx index 9cce9cf5fa17..c4d78f5aaf18 100644 --- a/website/docs/deployment.mdx +++ b/website/docs/deployment.mdx @@ -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: