From f1a504e813ae58ad835612d77dcf7f18fdbd410a Mon Sep 17 00:00:00 2001 From: Leo Lamprecht Date: Mon, 22 Jul 2019 22:55:00 +0200 Subject: [PATCH] docs: suggest ZEIT Now for quick deployment of 2.0 (#1691) * Suggest quick deployments for Docusaurus 2.0 * Sub heading * Sub heading * Sub heading * Sub heading * Update getting-started-publishing.md * Update getting-started-publishing.md * Update getting-started-publishing.md * Update getting-started-publishing.md * Update deployment.md * Added to auto-deploy section * Added to auto-deploy section * Added to auto-deploy section * Added to auto-deploy section * Mention Git integration * Update deployment.md * Update deployment.md --- docs/getting-started-publishing.md | 8 ++++-- .../getting-started-publishing.md | 8 ++++-- .../getting-started-publishing.md | 8 ++++-- .../getting-started-publishing.md | 8 ++++-- website/docs/deployment.md | 28 +++++++++++++++---- 5 files changed, 47 insertions(+), 13 deletions(-) diff --git a/docs/getting-started-publishing.md b/docs/getting-started-publishing.md index 0c205f990f..571f83508a 100644 --- a/docs/getting-started-publishing.md +++ b/docs/getting-started-publishing.md @@ -30,7 +30,7 @@ At this point, you can grab all of the files inside the `website/build` director * [Netlify](#hosting-on-netlify) * [Render](#hosting-on-render) -## Using ZEIT Now +### Using ZEIT Now Deploying your Docusaurus project to [ZEIT Now](https://zeit.co/now) will provide you with [various benefits](https://zeit.co/now) in the areas of performance and ease of use. @@ -42,7 +42,7 @@ Most importantly, however, deploying a Docusaurus project only takes a couple se npm i -g now ``` -2. Run a single command inside the directory if your project: +2. Run a single command inside the root directory of your project: ```bash now @@ -239,6 +239,10 @@ script: Now, whenever a new commit lands in `master`, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the `publish-gh-pages` script. +### Hosting on ZEIT Now + +With [ZEIT Now](#using-zeit-now), you can deploy your site easily and connect it to [GitHub](https://zeit.co/github) or [GitLab](https://zeit.co/gitlab) to automatically receive a new deployment every time you push a commit. + ### Hosting on Netlify Steps to configure your Docusaurus-powered site on Netlify. diff --git a/website-1.x/versioned_docs/version-1.10.x/getting-started-publishing.md b/website-1.x/versioned_docs/version-1.10.x/getting-started-publishing.md index 751b0d525f..e88b911744 100644 --- a/website-1.x/versioned_docs/version-1.10.x/getting-started-publishing.md +++ b/website-1.x/versioned_docs/version-1.10.x/getting-started-publishing.md @@ -30,7 +30,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) -## Using ZEIT Now +### Using ZEIT Now Deploying your Docusaurus project to [ZEIT Now](https://zeit.co/now) will provide you with [various benefits](https://zeit.co/now) in the areas of performance and ease of use. @@ -42,7 +42,7 @@ Most importantly, however, deploying a Docusaurus project only takes a couple se npm i -g now ``` -2. Run a single command inside the directory if your project: +2. Run a single command inside the root directory of your project: ```bash now @@ -239,6 +239,10 @@ script: Now, whenever a new commit lands in `master`, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the `publish-gh-pages` script. +### Hosting on ZEIT Now + +With [ZEIT Now](#using-zeit-now), you can deploy your site easily and connect it to [GitHub](https://zeit.co/github) or [GitLab](https://zeit.co/gitlab) to automatically receive a new deployment every time you push a commit. + ### Hosting on Netlify Steps to configure your Docusaurus-powered site on Netlify. diff --git a/website-1.x/versioned_docs/version-1.12.0/getting-started-publishing.md b/website-1.x/versioned_docs/version-1.12.0/getting-started-publishing.md index b36a2669db..18cd7853f2 100644 --- a/website-1.x/versioned_docs/version-1.12.0/getting-started-publishing.md +++ b/website-1.x/versioned_docs/version-1.12.0/getting-started-publishing.md @@ -31,7 +31,7 @@ At this point, you can grab all of the files inside the `website/build` director * [Netlify](#hosting-on-netlify) * [Render](#hosting-on-render) -## Using ZEIT Now +### Using ZEIT Now Deploying your Docusaurus project to [ZEIT Now](https://zeit.co/now) will provide you with [various benefits](https://zeit.co/now) in the areas of performance and ease of use. @@ -43,7 +43,7 @@ Most importantly, however, deploying a Docusaurus project only takes a couple se npm i -g now ``` -2. Run a single command inside the directory if your project: +2. Run a single command inside the root directory of your project: ```bash now @@ -240,6 +240,10 @@ script: Now, whenever a new commit lands in `master`, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the `publish-gh-pages` script. +### Hosting on ZEIT Now + +With [ZEIT Now](#using-zeit-now), you can deploy your site easily and connect it to [GitHub](https://zeit.co/github) or [GitLab](https://zeit.co/gitlab) to automatically receive a new deployment every time you push a commit. + ### Hosting on Netlify Steps to configure your Docusaurus-powered site on Netlify. diff --git a/website-1.x/versioned_docs/version-1.9.x/getting-started-publishing.md b/website-1.x/versioned_docs/version-1.9.x/getting-started-publishing.md index 8dea51684b..6780f26f08 100644 --- a/website-1.x/versioned_docs/version-1.9.x/getting-started-publishing.md +++ b/website-1.x/versioned_docs/version-1.9.x/getting-started-publishing.md @@ -30,7 +30,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) -## Using ZEIT Now +### Using ZEIT Now Deploying your Docusaurus project to [ZEIT Now](https://zeit.co/now) will provide you with [various benefits](https://zeit.co/now) in the areas of performance and ease of use. @@ -42,7 +42,7 @@ Most importantly, however, deploying a Docusaurus project only takes a couple se npm i -g now ``` -2. Run a single command inside the directory if your project: +2. Run a single command inside the root directory of your project: ```bash now @@ -239,6 +239,10 @@ script: Now, whenever a new commit lands in `master`, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the `publish-gh-pages` script. +### Hosting on ZEIT Now + +With [ZEIT Now](#using-zeit-now), you can deploy your site easily and connect it to [GitHub](https://zeit.co/github) or [GitLab](https://zeit.co/gitlab) to automatically receive a new deployment every time you push a commit. + ### Hosting on Netlify Steps to configure your Docusaurus-powered site on Netlify. diff --git a/website/docs/deployment.md b/website/docs/deployment.md index 4aace0def1..005bc3c7de 100644 --- a/website/docs/deployment.md +++ b/website/docs/deployment.md @@ -11,7 +11,29 @@ 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/), [Now](https://zeit.co/now), [Netlify](https://www.netlify.com/), and [Render](https://render.com/static-sites). Docusaurus sites are statically rendered so they work without JavaScript too! +You can deploy your site to static site hosting services such as [ZEIT Now](https://zeit.co/now), [GitHub Pages](https://pages.github.com/), [Netlify](https://www.netlify.com/), and [Render](https://render.com/static-sites). Docusaurus sites are statically rendered so they work without JavaScript too! + +## Deploying to ZEIT Now + +Deploying your Docusaurus project to [ZEIT Now](https://zeit.co/now) will provide you with [various benefits](https://zeit.co/now) in the areas of performance and ease of use. + +Most importantly, however, deploying a Docusaurus project only takes a couple seconds: + +1. First, install their [command-line interface](https://zeit.co/download): + +```bash +npm i -g now +``` + +2. Run a single command inside the root directory of your project: + +```bash +now +``` + +**That's all.** Your docs will automatically be deployed. + +Now you can connect your site to [GitHub](https://zeit.co/github) or [GitLab](https://zeit.co/gitlab) to automatically receive a new deployment every time you push a commit. ## Deploying to GitHub Pages @@ -76,10 +98,6 @@ References: --> -## Deploying to Now - -_This section is a work in progress. [Welcoming PRs](https://github.com/facebook/docusaurus/issues/1640)._ - ## Deploying to Netlify _This section is a work in progress. [Welcoming PRs](https://github.com/facebook/docusaurus/issues/1640)._