-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Added Multi-Region Deployment Admonition. #60298
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
base: branch/v18
Are you sure you want to change the base?
Conversation
Amplify deployment status
|
is a requirement. We recommend the [High Availability | ||
Cluster](high-availability.mdx) for most deployments. | ||
|
||
Also, this guide must be followed precisely with no modifications or |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's switch to active voice: Please follow this guide precisely with no modifications. If you modify any parts of this guide, we would not be able to support your deployment.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We actually state immediately below this that it's not a guide, but rather a blueprint:
This page describes how to deploy a Teleport cluster in multiple regions to improve resiliency and sustain regional failure. This is not a step-by-step guide but a blueprint on how to build a multi-region Teleport cluster. This blueprint must be adapted to work with your specific infrastructure and network constraints.
Can we do one of the following?
- swap the word
guide
forblueprint
to reduce cognitive dissonance - remove the paragraph that follows this
- both 1 and 2
I have a slight preference for 3 because a) using the word "blueprint" will be more consistent with the rest of the doc, b) the first sentence of the paragraph is duplicative of the new danger text, and c) the 3rd sentence creates cognitive dissonance with the danger text where it says that "This blueprint must be adapted..."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it would make sense to move the Admonition just below the first paragraph so readers know what the scope of the guide is first. That way, once they see the Admonition, they'll know what "this deployment" means.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
approved with small change to active voice
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also approving with small changes requested in the same thread as Sasha's.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm once @klizhentas comment is applied
No description provided.