Catch misuses of the Var component #51081
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
|
Amplify deployment status
|
tigrato
approved these changes
Jan 16, 2025
strideynet
approved these changes
Jan 16, 2025
2eda189 to
dc7d6c1
Compare
Closes #29905 Add a Vale style rule to catch docs pages in which there is a single instance of a Var. This ensures that Vars reuse information as intended. Also fix single-instance Vars that violate the rule. For the most part, this means either: - Instructing the user to assign the Var, meaning that there are no easy-to-miss Vars hiding in a configuration snippet - Removing unnecessary Vars, e.g., if an example command is meant to illustrate a possibility and is not mean to be copied and pasted - Fixing mistakes in Var usage, e.g., a Proxy Service address variable that has two possible names, `teleport.example.com` and `example.teleport.sh`.
dc7d6c1 to
8e60f3f
Compare
auto-merge was automatically disabled
January 16, 2025 18:47
Pull Request is not mergeable
ptgott
added a commit
that referenced
this pull request
Jan 17, 2025
Backports #51081 Closes #29905 Add a Vale style rule to catch docs pages in which there is a single instance of a Var. This ensures that Vars reuse information as intended. Also fix single-instance Vars that violate the rule. For the most part, this means either: - Instructing the user to assign the Var, meaning that there are no easy-to-miss Vars hiding in a configuration snippet - Removing unnecessary Vars, e.g., if an example command is meant to illustrate a possibility and is not mean to be copied and pasted - Fixing mistakes in Var usage, e.g., a Proxy Service address variable that has two possible names, `teleport.example.com` and `example.teleport.sh`.
ptgott
added a commit
that referenced
this pull request
Jan 17, 2025
Backports #51081 Closes #29905 Add a Vale style rule to catch docs pages in which there is a single instance of a Var. This ensures that Vars reuse information as intended. Also fix single-instance Vars that violate the rule. For the most part, this means either: - Instructing the user to assign the Var, meaning that there are no easy-to-miss Vars hiding in a configuration snippet - Removing unnecessary Vars, e.g., if an example command is meant to illustrate a possibility and is not mean to be copied and pasted - Fixing mistakes in Var usage, e.g., a Proxy Service address variable that has two possible names, `teleport.example.com` and `example.teleport.sh`.
mvbrock
pushed a commit
that referenced
this pull request
Jan 18, 2025
Closes #29905 Add a Vale style rule to catch docs pages in which there is a single instance of a Var. This ensures that Vars reuse information as intended. Also fix single-instance Vars that violate the rule. For the most part, this means either: - Instructing the user to assign the Var, meaning that there are no easy-to-miss Vars hiding in a configuration snippet - Removing unnecessary Vars, e.g., if an example command is meant to illustrate a possibility and is not mean to be copied and pasted - Fixing mistakes in Var usage, e.g., a Proxy Service address variable that has two possible names, `teleport.example.com` and `example.teleport.sh`.
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.
Closes #29905
Add a Vale style rule to catch docs pages in which there is a single instance of a Var. This ensures that Vars reuse information as intended.
Also fix single-instance Vars that violate the rule. For the most part, this means either:
teleport.example.comandexample.teleport.sh.