docs(v2): add documentation on versioning #2038
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
endiliey
added
the
pr: documentation
|
Deploy preview for docusaurus-2 ready! Built with commit 04b8909 |
|
Deploy preview for docusaurus-preview ready! Built with commit 04b8909 |
yangshun
approved these changes
Nov 24, 2019
There was a problem hiding this comment.
Thanks for adding this! I proofread it and made some minor edits.
Some other recommended practices I can think of:
- Don't use relative paths within the docs. Because when we cut a version the paths no longer work (the nesting level is different, among other reasons)
- Assets can still be referenced in historical version of docs and should only be renamed/deleted if you are sure they are no longer referenced
yangshun
reviewed
Nov 24, 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
Write documentation on versioning. Feel free to edit :)
Don't merge till #2030 is merged please, because versioning hasn't been released yet
Have you read the Contributing Guidelines on pull requests?
yes
Test Plan
Use netlify