Docs: reduce visibility of Config File V1 #8887
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
|
Discussed in the underlying #8648, we can get more aggressive with this change and I think it would help doc clarity. The main points on that issue are 1) don't refer to our config file as v2 and 2) remove the nesting of the configuration file index, just get straight to our configuration file details. |
|
I'm moving this out to next's week deploy. |
ericholscher
approved these changes
Feb 8, 2022
People is still arriving at Config File V1 and we want to avoid that as much as possible. However, we can't yet remove this documentation page since it's still working and there are people already using it. We should find a way to migrate these projects off from Config File V1 and finally remove this documentation page. However, that requires a much bigger amount of work.
humitos
force-pushed
the
humitos/visibility-config-v1
branch
from
07086a9 to
80bea10
Compare
|
I will merge this small change as-is for now. We should come back to do a bigger refactor for our config docs. However, hiding this page will reduce the problem of people finding these docs and thinking they are up to date and they should use them. |
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.
People is still arriving at Config File V1 and we want to avoid that as much as
possible. However, we can't yet remove this documentation page since it's still
working and there are people already using it.
We should find a way to migrate these projects off from Config File V1 and
finally remove this documentation page. However, that requires a much bigger
amount of work.
Closes #8857