chore(v2): v2 website should make it easy to contribute to upstream docs#3506
Merged
chore(v2): v2 website should make it easy to contribute to upstream docs#3506
Conversation
… docs the main docs so that editUrl will modify upstream docs in priority
slorber
added
pr: maintenance
Contributor
|
Deploy preview for docusaurus-2 ready! Built with commit a618141 |
lex111
reviewed
Sep 30, 2020
Contributor
lex111
left a comment
lex111
left a comment
There was a problem hiding this comment.
I like this idea, so we need to replace 'next' label with 'unreleased' one, right?
Collaborator
Author
|
Yes, this is ready here: https://deploy-preview-3506--docusaurus-2.netlify.app/classic/ |
Collaborator
Author
|
erf there's the banner here that is annoying now 😅
will try to fix it as part of #3013 |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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
By default, in prod, the "latest version" is the last release, not "next".
This lead to the editUrl targeting docs of a specific version, not upstream docs.
This leads to maintainers asking to port the doc fixes to upstream docs, and sometimes merging by mistake to the versioned docs, so the doc fix would disappear.
Here is an example: #3428 (comment)
By defaulting to the next version in prod, we nudge contributors and maintainers to contribute to upstream docs in priority.
The label
(unreleased)can help make it obvious that it's the doc for an unreleased version, so that the user can switch if needed.But anyway, between one alpha to another, the docs do not change that much, so I think this new behavior is fine for the whole alpha phase.
@lex111 @yangshun any opinion?