3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-04-29 10:17:55 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs: add explanation about versioned docs to CONTRIBUTING (#986)

Browse source 
* Add explanation about versioned docs to readme

* Update CONTRIBUTING.md
This commit is contained in:
Atul Bhosale 2018-09-30 06:53:00 +05:30 • committed by Yangshun Tay
parent 8691a2525c
commit c24e9bfb7f
1 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
CONTRIBUTING.md
View file

@ -18,6 +18,15 @@ There are many ways to contribute to Docusaurus, and many of them do not involve
Contributions are very welcome. If you think you need help planning your contribution, please ping us on Twitter at [@docusaurus](https://twitter.com/docusaurus) and let us know you are looking for a bit of help.
### Versioned Docs
If you only want to make content changes you just need to know about versioned docs.
- `/docs` - The files in here are responsible for the "next" version at https://docusaurus.io/docs/en/next/installation.
- `v1/website/versioned_docs/version-X.Y.Z` - These are the docs for the X.Y.Z version at https://docusaurus.io/docs/en/X.Y.Z/installation.
To make a fix to the published versions you must edit the corresponding markdown file in both folders. If you only made changes in `docs`, be sure to be viewing the `next` version to see the updates (ensure there's `next` in the URL).
### Join our Discord Channel
We have `#docusaurus-dev` on [Discord](https://discord.gg/docusaurus) to discuss all things Docusaurus development.