Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add Render hosting guide #1615

Merged
merged 3 commits into from
Jul 12, 2019
Merged

docs: add Render hosting guide #1615

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ba7c866
Add Render deployment guide
anurag Jul 12, 2019
ea2b4a6
Add guide for Docusaurus 2
anurag Jul 12, 2019
f05e644
Update guide for v2
anurag Jul 12, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions docs/getting-started-publishing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ At this point, you can grab all of the files inside the `website/build` director

* [GitHub Pages](#using-github-pages)
* [Netlify](#hosting-on-netlify)
* [Render](#hosting-on-render)

### Using GitHub Pages

Expand Down Expand Up @@ -233,6 +234,33 @@ Steps to configure your Docusaurus-powered site on Netlify.

You can also configure Netlify to rebuild on every commit to your repository, or only `master` branch commits.

### Hosting on Render

Render offers free [static site](https://render.com/docs/static-sites) hosting with fully managed SSL, custom domains, a global CDN and continuous auto deploys from your Git repo. Deploy your app in just a few minutes by following these steps.

1. Create a new **Web Service** on Render, and give Render's GitHub app permission to access your Docusaurus repo.

2. Select the branch to deploy. The default is `master`.

2. Enter the following values during creation.

| Field | Value |
| ------- | ----- |
| **Environment** | `Static Site` |
| **Build Command** | `cd website; yarn install; yarn build` |
| **Publish Directory** | `website/build/<projectName>` |

`projectName` is the value you defined in your `siteConfig.js`.

```javascript{7}
const siteConfig = {
// ...
projectName: 'your-project-name',
// ...
```

That's it! Your app will be live on your Render URL as soon as the build finishes.

### Publishing to GitHub Enterprise

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.
Expand Down
20 changes: 19 additions & 1 deletion website/docs/deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ npm build

Once it finishes, you should see the production build under the `build/` directory.

You can deploy your site to static site hosting services such as [GitHub Pages](https://pages.github.com/), [Netlify](https://www.netlify.com/). Docusaurus sites are server rendered so they work without JavaScript too!
You can deploy your site to static site hosting services such as [GitHub Pages](https://pages.github.com/), [Render](https://render.com/static-sites), and [Netlify](https://www.netlify.com/). Docusaurus sites are server rendered so they work without JavaScript too!

## Deploying to GitHub Pages

Expand Down Expand Up @@ -76,6 +76,24 @@ References:

-->

## Deploying to Render

Render offers [free static site hosting](https://render.com/docs/static-sites) with fully managed SSL, custom domains, a global CDN and continuous auto deploys from your Git repo. Deploy your app in just a few minutes by following these steps.

1. Create a new **Web Service** on Render, and give Render permission to access your Docusaurus repo.

2. Select the branch to deploy. The default is `master`.

2. Enter the following values during creation.

| Field | Value |
| ------- | ----- |
| **Environment** | `Static Site` |
| **Build Command** | `yarn build` |
| **Publish Directory** | `build` |

That's it! Your app will be live on your Render URL as soon as the build finishes.

## Deployment with Netlify

_This section is a work in progress. [Welcoming PRs](https://github.com/facebook/docusaurus/issues/1640)._