Skip to content

Commit

Permalink
docs: add explanation about versioned docs to CONTRIBUTING (#986)
Browse files Browse the repository at this point in the history
* Add explanation about versioned docs to readme

* Update CONTRIBUTING.md
  • Loading branch information
Atul9 authored and yangshun committed Sep 30, 2018
1 parent 8691a25 commit c24e9bf
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit c24e9bf

Please sign in to comment.