Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify the style rule for Teleport editions #42025

Merged
merged 1 commit into from
Jun 6, 2024

Conversation

ptgott
Copy link
Contributor

@ptgott ptgott commented May 24, 2024

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.

Copy link

The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with changelog: followed by the changelog entries for the PR.

@ptgott
Copy link
Contributor Author

ptgott commented May 24, 2024

Context: #41285 (comment)

@public-teleport-github-review-bot public-teleport-github-review-bot bot removed the request for review from strideynet May 27, 2024 15:30
@webvictim
Copy link
Contributor

webvictim commented May 27, 2024

Honestly I still kinda think this is confusing.

Saying "cloud-hosted Teleport Enterprise" doesn't really make a distinction between:

  1. someone hosting Teleport Enterprise themselves in their own cloud
  2. our SaaS platform

Both are technically cloud-hosted Teleport Enterprise, but our SaaS has a few more arbitrary limitations such as #42060

"Teleport Enterprise Cloud" did, at the least, have a name that was distinct enough to discern SaaS from non-SaaS.

@ptgott
Copy link
Contributor Author

ptgott commented May 28, 2024

@webvictim Would it make more sense to say "managed Teleport Enterprise" in the docs instead of "cloud-hosted"?

@webvictim
Copy link
Contributor

Yeah, that sounds much better!

@ptgott ptgott force-pushed the paul.gottschling/2024-05-24-edition-rule branch from b5c5e7b to f84d4f3 Compare June 6, 2024 21:52
@ptgott ptgott enabled auto-merge June 6, 2024 21:52
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.
@ptgott ptgott force-pushed the paul.gottschling/2024-05-24-edition-rule branch from f84d4f3 to f2df0d8 Compare June 6, 2024 21:52
Copy link

github-actions bot commented Jun 6, 2024

The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with changelog: followed by the changelog entries for the PR.

1 similar comment
Copy link

github-actions bot commented Jun 6, 2024

The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with changelog: followed by the changelog entries for the PR.

@ptgott ptgott added the no-changelog Indicates that a PR does not require a changelog entry label Jun 6, 2024
@ptgott ptgott added this pull request to the merge queue Jun 6, 2024
Merged via the queue into master with commit 44ded56 Jun 6, 2024
37 of 38 checks passed
@ptgott ptgott deleted the paul.gottschling/2024-05-24-edition-rule branch June 6, 2024 22:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changelog Indicates that a PR does not require a changelog entry size/sm
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants