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

Jump to bottom

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

Merged
merged 1 commit into from
Dec 29, 2020
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 19 additions & 11 deletions website/docs/migration/migration-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down