Skip to content

Conversation

russjones
Copy link
Contributor

No description provided.

@github-actions github-actions bot added backport documentation no-changelog Indicates that a PR does not require a changelog entry size/sm labels Oct 16, 2025
Copy link

github-actions bot commented Oct 16, 2025

Amplify deployment status

Branch Commit Job ID Status Preview Updated (UTC)
rjones/multi-region-admonition HEAD 1 ✅SUCCEED rjones-multi-region-admonition 2025-10-16 00:57:27

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
Copy link
Contributor

@klizhentas klizhentas Oct 16, 2025

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.

Copy link
Contributor

@roraback roraback Oct 16, 2025

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?

  1. swap the word guide for blueprint to reduce cognitive dissonance
  2. remove the paragraph that follows this
  3. 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..."

Copy link
Contributor

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.

Copy link
Contributor

@klizhentas klizhentas left a 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

Copy link
Contributor

@roraback roraback left a 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.

Copy link
Collaborator

@r0mant r0mant left a 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport documentation 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.

5 participants