From db1faa099ecb7b1392b787de5002c276df682fc5 Mon Sep 17 00:00:00 2001 From: Yangshun Tay Date: Sat, 7 Dec 2019 23:47:33 -0800 Subject: [PATCH] docs: mention about moving docs directory into website --- docs/getting-started-publishing.md | 2 ++ website/docs/migrating-from-v1-to-v2.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/docs/getting-started-publishing.md b/docs/getting-started-publishing.md index 25997d47c7dc..b5f346b8a4f5 100644 --- a/docs/getting-started-publishing.md +++ b/docs/getting-started-publishing.md @@ -50,6 +50,8 @@ now **That's all.** Your docs will automatically be deployed. +> Note that the directory structure Now supports is slightly different from the default directory structure of a Docusaurus project - The `docs` directory has to be within the `website` directory, ideally following the directory structure in this example. You will also have to specify a `customDocsPath` value in `siteConfig.js`. Take a look at the the [now-examples repository for a Docusaurus project](https://github.com/zeit/now-examples/tree/master/docusaurus). + ### Using GitHub Pages 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/). diff --git a/website/docs/migrating-from-v1-to-v2.md b/website/docs/migrating-from-v1-to-v2.md index 6aa4657d8fb3..a0d5edbcd973 100644 --- a/website/docs/migrating-from-v1-to-v2.md +++ b/website/docs/migrating-from-v1-to-v2.md @@ -153,6 +153,8 @@ module.exports = { }; ``` +We recommend moving the `docs` folder into the `website` folder and that is also the default directory structure in v2. [Now](https://zeit.co/now) supports [Docusaurus project deployments out-of-the-box](https://github.com/zeit/now-examples/tree/master/docusaurus) if the `docs` directory is within the `website`. It is also generally better for the docs to be within the website so that the docs and the rest of the website code are co-located within one `website` directory. + Refer to migration guide below for each field in `siteConfig.js`. ### Updated fields