From e5610a475d55dfe446eef89daea87bf9d2d7a3b4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Lorber?= Date: Tue, 29 Dec 2020 10:57:35 +0100 Subject: [PATCH] docs(v2): Add migration info doc regarding docs folder location (#3962) --- website/docs/migration/migration-overview.md | 30 +++++++++++++------- 1 file changed, 19 insertions(+), 11 deletions(-) diff --git a/website/docs/migration/migration-overview.md b/website/docs/migration/migration-overview.md index 7e96ec37fb..0f89ca9729 100644 --- a/website/docs/migration/migration-overview.md +++ b/website/docs/migration/migration-overview.md @@ -33,22 +33,30 @@ Your Docusaurus 1 site should have the following structure: ## Docusaurus 2 structure -After the migration, your Docusaurus 2 site should look like: +After the migration, your Docusaurus 2 site could look like: ```sh -website -├── blog ├── docs -├── src -│ ├── components -│ ├── css -│ └── pages -├── static -├── package.json -├── sidebars.json -├── docusaurus.config.js +└── website + ├── blog + ├── src + │ ├── components + │ ├── css + │ └── pages + ├── static + ├── package.json + ├── sidebars.json + ├── docusaurus.config.js ``` +:::info + +This migration does not change the `/docs` folder location, but Docusaurus v2 sites generally have the `/docs` folder inside `/website` + +You are free to put the `/docs` folder anywhere you want after having migrated to v2. + +::: + ## Migration process There are multiple things to migrate to obtain a fully functional Docusaurus 2 website: