From ec5c47dc4b21745ea5b3bd586b01df568313ea1e Mon Sep 17 00:00:00 2001 From: Website Deployment Script Date: Fri, 17 Nov 2017 22:27:34 +0000 Subject: [PATCH] Deploy website Deploy website version based on 4f2487607345e202a7bc37d7f822e184b5c8a0a0 --- docs/en/publishing.html | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/en/publishing.html b/docs/en/publishing.html index 659d2454de..77965b039c 100644 --- a/docs/en/publishing.html +++ b/docs/en/publishing.html @@ -26,9 +26,12 @@
  • CIRCLE_PROJECT_USERNAME: The GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebookexperimental" GitHub organization.
  • CIRCLE_PROJECT_REPONAME: The name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebookexperimental/docusaurus, so our repo name in this case would be "docusaurus".
  • GIT_USER: The username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
    • -
  • CIRCLE_BRANCH: The branch that contains the latest docs changes that will be deployed. Usually, "master".
    • +
  • CIRCLE_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.
    • +

    We currently require the published documentation to be served from the gh-pages branch in your GitHub repo.

    +
    +

    The reason we prefix some of these parameters with CIRCLE is because Docusaurus recommends publishing your documentation continuously when changes are committed via CircleCI.

    Once you have the paremeter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders: