Skip to content

Commit

Permalink
Clarify the style rule for Teleport editions (#42025)
Browse files Browse the repository at this point in the history
Encourage authors to take a more flexible approach to mentioning
cloud-hosted and self-hosted Teleport Enterprise. In the current vale
style rule for Teleport editions, the alternative to "Teleport
Enterprise Cloud" seemed to be a more rigid suggestion to use "Teleport
Enterprise (cloud-hosted)", which is usually not the smoothest way to
express this information.
  • Loading branch information
ptgott authored Jun 6, 2024
1 parent 69196c7 commit 44ded56
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion .github/vale-styles/messaging/edition-names.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ extends: existence
scope:
# Using the raw scope so we can catch instances in TabItem labels.
- raw
message: '"%s" is no longer a recognized Teleport edition. Use "Teleport Enterprise" instead, and clarify the hosting type in parentheses rather than including it in the name of the product, e.g., "Teleport Enterprise (self-hosted)" or "Teleport Enterprise (cloud-hosted)".'
message: '"%s" is no longer a recognized Teleport edition. Use "Teleport Enterprise" instead, and clarify the hosting type rather than including it in the name of the product. For example, you could say, "For managed Teleport Enterprise...", "Teleport Enterprise (managed)", "self-hosted Teleport Enterprise," etc., as long as the implication is that Teleport Enterprise is a single product that users can host in two ways. If the hosting type is not important in a given sentence, there is no need to specify it.'
level: error
ignorecase: false
tokens:
Expand Down

0 comments on commit 44ded56

Please sign in to comment.