3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-06-01 02:12:36 +02:00
Code Issues Projects Releases Packages Wiki Activity

refactor: rename Git master branch to main (#5345)

Browse source 
* Prepare to renaming master branch to main

* Update CONTRIBUTING.md

* Update packages/docusaurus-migrate/src/__tests__/__fixtures__/missing_version_website/website/package.json

* Update packages/docusaurus-migrate/src/__tests__/__fixtures__/complex_website/website/package.json

* Update packages/docusaurus-migrate/src/__tests__/__fixtures__/simple_website/website/package.json

* missing master -> main replaces

* useless char

* For GH Pages org deploy, DEPLOYMENT_BRANCH env is now required

* fix versioning page

* fix vercel links

* update deployment.mdx

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
Co-authored-by: slorber <lorber.sebastien@gmail.com>
This commit is contained in:
Paul O’Shannessy 2021-08-17 09:41:53 -07:00 • committed by GitHub
parent 33a85c71aa
commit 8341527fc9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
77 changed files with 230 additions and 206 deletions
Download patch file Download diff file Expand all files Collapse all files

20
website/docs/guides/docs/versioning.md
View file

@ -20,8 +20,8 @@ To better understand how versioning works and see if it suits your needs, you ca
```shell
website
├── sidebars.json # sidebar for master (next) version
├── docs # docs directory for master (next) version
├── sidebars.json # sidebar for the current docs version
├── docs # docs directory for the current docs version
│ ├── foo
│ │ └── bar.md # https://mysite.com/docs/next/foo/bar
│ └── hello.md # https://mysite.com/docs/next/hello
@ -48,11 +48,19 @@ The table below explains how a versioned file maps to its version and the genera
| --------------------------------------- | -------------- | ----------------- |
| `versioned_docs/version-1.0.0/hello.md` | 1.0.0 | /docs/1.0.0/hello |
| `versioned_docs/version-1.1.0/hello.md` | 1.1.0 (latest) | /docs/hello |
| `docs/hello.md` | next | /docs/next/hello |
| `docs/hello.md` | current | /docs/next/hello |
:::tip
The files in the `docs` directory belong to the `current` docs version.
By default, the `current` docs version is labelled as `Next` and hosted under `/docs/next/*`, but is entirely configurable to fit your project's release lifecycle.
:::
### Tagging a new version {#tagging-a-new-version}
1. First, make sure your content in the `docs` directory is ready to be frozen as a version. A version always should be based from master.
1. First, make sure the current docs version (the `docs` directory) is ready to be frozen.
1. Enter a new version number.
```bash npm2yarn
@ -72,7 +80,7 @@ When tagging a new version, the document versioning mechanism will:
1. Place the new file into the corresponding version folder.
1. Include the reference for the new file into the corresponding sidebar file, according to version number.
**Master docs**
**Current version docs**
```shell
# The new file.
@ -82,7 +90,7 @@ docs/new.md
sidebar.js
```
**Older docs**
**Older version docs**
```shell
# The new file.