docs(v2): Add migration info doc regarding docs folder location (#3962)

This commit is contained in:
Sébastien Lorber 2020-12-29 10:57:35 +01:00 committed by GitHub
parent 141d062c3b
commit e5610a475d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -33,22 +33,30 @@ Your Docusaurus 1 site should have the following structure:
## Docusaurus 2 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 ```sh
website
├── blog
├── docs ├── docs
├── src └── website
│ ├── components ├── blog
│ ├── css ├── src
│ └── pages │ ├── components
├── static │ ├── css
├── package.json │ └── pages
├── sidebars.json ├── static
├── docusaurus.config.js ├── 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 ## Migration process
There are multiple things to migrate to obtain a fully functional Docusaurus 2 website: There are multiple things to migrate to obtain a fully functional Docusaurus 2 website: