chore: fold versions & cleanup #1313
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Deploy preview for docusaurus-2 ready! Built with commit 84c8b20 |
|
Deploy preview for docusaurus-preview ready! Built with commit 84c8b20 |
yangshun
approved these changes
Mar 28, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Inspired from jestjs/jest#7705
According to semantic versioning, X.Y.Z version means X is major, Y is minor and Z is patch
Given a version number MAJOR.MINOR.PATCH, increment the:
MAJOR version when you make incompatible API changes,
MINOR version when you add functionality in a backwards-compatible manner, and
PATCH version when you make backwards-compatible bug fixes.
It's not a good idea for us to cut new docs for PATCH version because its only bug fixes and by right there shouldn't be much change to the documentation. It's also not good to keep too many version as that makes our build process even slower.
We can see that other popular OSS project is doing this too:
Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
Comparison
Locally start
Versions working - https://deploy-preview-1313--docusaurus-preview.netlify.com/en/versions
Old docs still working - https://deploy-preview-1313--docusaurus-preview.netlify.com/docs/en/1.2.x/installation