From c24e9bfb7f47135771ca4223ef8315b949c6638f Mon Sep 17 00:00:00 2001 From: Atul Bhosale Date: Sun, 30 Sep 2018 06:53:00 +0530 Subject: [PATCH] docs: add explanation about versioned docs to CONTRIBUTING (#986) * Add explanation about versioned docs to readme * Update CONTRIBUTING.md --- CONTRIBUTING.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2ea35c70ae..da5020c268 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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.