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

Update the publishing documentation

Browse source
This commit is contained in:
Joel Marcey 2017-11-17 14:04:47 -08:00
parent 909c193fa1
commit 59d5b58aa5
1 changed files with 30 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

54
docs/getting-started-publishing.md
View file

@ -17,38 +17,42 @@ This will generate a `build` folder inside the `website` directory containing th
## Hosting Static HTML Pages
At this point, you can grab all of the files inside the `website/build` folder and copy them over to your favorite web server's "html" directory. For example, both Apache and nginx serve content from `/var/www/html` by default. You'll still need to host the web server somewhere, and as it happens, choosing a web hosting provider is out of scope for this guide. Don't fret, as Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: [GitHub Pages](https://pages.github.com/).
At this point, you can grab all of the files inside the `website/build` folder and copy them over to your favorite web server's "html" directory.
> For example, both Apache and nginx serve content from `/var/www/html` by default. That said, choosing a web server or provider is outside the scope of Docusaurus.
### Using GitHub Pages
While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: [GitHub Pages](https://pages.github.com/).
Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.
> Even if your repo is private, anything published to a `gh-pages` branch will be [public](https://help.github.com/articles/user-organization-and-project-pages/).
Most of the work to publish to GitHub pages is done for you automatically through the [`publish-gh-pages`](./commands.md#docusaurus-publish) script. You just need to determine the values for a few parameters required by the script.
Most of the work to publish to GitHub pages is done for you automatically through the [`publish-gh-pages`](./commands.md#docusaurus-publish) script. You just need to determine the values for a few parameters required by the script. The required parameters are:
- `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".
> The reason we prefix some of these parameters with `CIRCLE` is because Docusaurus recommends publishing your documentation continuously when changes are committed via [CircleCI](https://circleci.org).
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:
To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate.
```
GIT_USER=<GIT_USER> \
CIRCLE_PROJECT_USERNAME=<CIRCLE_PROJECT_REPONAME> \
CIRCLE_PROJECT_REPONAME=<CIRCLE_PROJECT_USERNAME> \
CIRCLE_PROJECT_USERNAME=<CIRCLE_PROJECT_USERNAME> \
CIRCLE_PROJECT_REPONAME=<CIRCLE_PROJECT_REPONAME> \
CIRCLE_BRANCH=master \
yarn run publish-gh-pages
yarn run publish-gh-pages # or `npm run publish-gh-pages`
```
The require parameters are:
> The specified `GIT_USER` must have push access to the repository specified in the combination of `CIRCLE_PROJECT_USERNAME` and `CIRCLE_PROJECT_REPONAME`.
- `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".
- `CIRCLE_PROJECT_USERNAME`: The GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebookexperimental" GitHub organization.
- `GITHUB_USERNAME`: 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".
Once you have the parameters information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the `<...>` placeholders above:
```
yarn run publish-gh-pages # or `npm run publish-gh-pages`
```
You should now be able to load your website by visiting its GitHub Pages URL, which should be something along the lines of https://CIRCLE_PROJECT_USERNAME.github.io/CIRCLE_PROJECT_REPONAME. For example, Docusaurus's own GitHub Pages URL is https://facebookexperimental.github.io/docusaurus, because it is served from the `gh-pages` branch of the https://github.com/facebookexperimental/docusaurus GitHub repo. We highly encourage reading through the [GitHub Pages documentation](https://pages.github.com) 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://CIRCLE_PROJECT_USERNAME.github.io/CIRCLE_PROJECT_REPONAME, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://docusaurus.io (it can also be accessed via https://facebookexperimental.github.io/docusaurus), because it is served from the `gh-pages` branch of the https://github.com/facebookexperimental/docusaurus GitHub repo. We highly encourage reading through the [GitHub Pages documentation](https://pages.github.com) 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.
@ -62,7 +66,9 @@ Continuous integration (CI) services are typically used to perform routine tasks
If you're already using Circle CI for your project, all you need to do to enable automatic deployments is to configure Circle to run the `publish-gh-pages` script as part of the deployment step.
1. Go to https://github.com/settings/tokens and generate a new [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/), granting it full control of private repositories through the `repo` access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
1. Ensure the GitHub account that will be set as the `GIT_USER` has `write` access to the repo that contains the documentation.
1. Log into GitHub as the `GIT_USER`.
1. Go to https://github.com/settings/tokens for the `GIT_USER` and generate a new [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/), granting it full control of private repositories through the `repo` access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
1. Open your Circle CI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub org/repo.
1. Create a new environment variable named "GITHUB_TOKEN", using your newly generated access token as the value.
1. Open your `circle.yml` file and add the following under the `machine:` section to tell Circle to use relatively recent versions of node and npm, replacing npm with yarn if applicable:
@ -85,15 +91,15 @@ If you're already using Circle CI for your project, all you need to do to enable
- git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
- git config --global user.name "<YOUR_NAME>"
- echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
- cd website && npm install && GIT_USER=<GITHUB_USERNAME> npm run publish-gh-pages
- cd website && npm install && GIT_USER=<GIT_USER> npm run publish-gh-pages
```
Make sure to replace `<GITHUB_USERNAME>` with your actual GitHub username.
Make sure to replace `<GIT_USER>` with the actual username of the GitHub account that will be used to publish the documentation.
**DO NOT** place the actual value of $GITHUB_TOKEN in `circle.yml`. We already configured that as an environment variable back in Step 3.
**DO NOT** place the actual value of `$GITHUB_TOKEN` in `circle.yml`. We already configured that as an environment variable back in Step 3.
Since the script will run within the Circle environment, the values of `CIRCLE_PROJECT_USERNAME`, `CIRCLE_PROJECT_REPONAME`, and `CIRCLE_BRANCH` are already defined as environment variables and will be picked up by the script automatically.
> Unlike when you run the `publish-gh-pages` script manually, when the script runs within the Circle environment, the values of `CIRCLE_PROJECT_USERNAME`, `CIRCLE_PROJECT_REPONAME`, and `CIRCLE_BRANCH` are already defined as environment variables within CircleCI and will be picked up by the script automatically.
Now, whenever a new commit lands in `master`, Circle will run your suite of tests and, if everything passes, your website will be deployed via the `publish-gh-pages` script.
Now, whenever a new commit lands in `master`, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the `publish-gh-pages` script.
> If you would rather use a deploy key instead of a personal access token, you can by starting with the Circle CI [instructions](https://circleci.com/docs/1.0/adding-read-write-deployment-key/) for adding a read/write deploy key.