From 13a2c09427dcf338dd7aac51d9fb638198547996 Mon Sep 17 00:00:00 2001 From: Atul Bhosale Date: Wed, 26 Sep 2018 10:24:34 +0530 Subject: [PATCH 1/2] Add explanation about versioned docs to readme --- CONTRIBUTING.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2ea35c70ae8d..9c6591a43e21 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. +You might want to make yourself familiar with [docusaurus](https://docusaurus.io/docs/en/installation) to make significant changes to the website. If you only want to make content changes you just need to know about versioned docs. + +### 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-1.4.0` - these are the docs for the currently published version at https://docusaurus.io/docs/en/installation. + +To make a fix to the published site you must edit the corresponding markdown file at both folders. + ### Join our Discord Channel We have `#docusaurus-dev` on [Discord](https://discord.gg/docusaurus) to discuss all things Docusaurus development. From f9812c57960f161063043979246a7a89622438e6 Mon Sep 17 00:00:00 2001 From: Yangshun Tay Date: Sat, 29 Sep 2018 10:33:42 -0700 Subject: [PATCH 2/2] Update CONTRIBUTING.md --- CONTRIBUTING.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9c6591a43e21..da5020c2688f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,14 +18,14 @@ 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. -You might want to make yourself familiar with [docusaurus](https://docusaurus.io/docs/en/installation) to make significant changes to the website. If you only want to make content changes you just need to know about versioned docs. +### Versioned Docs -### 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-1.4.0` - these are the docs for the currently published version at https://docusaurus.io/docs/en/installation. +- `/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 site you must edit the corresponding markdown file at both folders. +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