From a8500e000c3e646c378686ff3bd2c155ce623f27 Mon Sep 17 00:00:00 2001 From: Website Deployment Script Date: Fri, 8 Feb 2019 13:27:56 +0000 Subject: [PATCH] Deploy website Deploy website version based on 1efaabc158e3e135e205f89e5f593a69db958a47 --- docs/en/next/publishing.html | 5 +++-- docs/en/next/publishing/index.html | 5 +++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/en/next/publishing.html b/docs/en/next/publishing.html index fd51b16cdb..0bc3d02758 100644 --- a/docs/en/next/publishing.html +++ b/docs/en/next/publishing.html @@ -161,7 +161,8 @@

If you run into issues related to SSH keys, visit GitHub's authentication documentation.

-

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (but it can also be accessed via https://docusaurus.io/ because of a CNAME), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. However, it can also be accessed via https://docusaurus.io/, via a generated CNAME file which can be configured via the cname siteConfig option.

+

We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

However, you can automate the publishing process with continuous integration (CI).

Automating Deployments Using Continuous Integration

@@ -296,7 +297,7 @@ e.g.

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

-
Last updated on 2019-1-18 by Marvin Chin
← Creating your siteDocker →