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

[v8] Convert the Trusted Clusters guide to a tutorial #13251

Merged
merged 1 commit into from
Jun 22, 2022

Conversation

ptgott
Copy link
Contributor

@ptgott ptgott commented Jun 7, 2022

Backports #10708

  • Edit the Trusted Clusters guide for Cloud

See #10633

  • Misc style/grammar/clarity tweaks
  • Turn the Teleport Node Tunneling Admonition into a Details
    box so it can be invisible for Cloud users. In Cloud, Nodes
    must connect via Node Tunneling.
  • Use Tabs components to add Cloud versions of CLI commands
  • Only show the static join token method for self-hosted users
    via Tabs
  • Use a Details box to show content relevant only for Enterprise
    and Cloud users
  • Remove an Admonition that was duplicated in the Troubleshooting
    section
  • Respond to PR feedback

  • Address PR feedback

  • Turn the Trusted Clusters guide into a tutorial

See: #11841

The Trusted Clusters guide is organized as a conceptual introduction,
with configuration/command snippets used as illustrations. To make this
guide easier to follow, I have structured it as a step-by-step tutorial
where a user should be able to copy each command/config snippet on
their own environment, establish trust between clusters, and connect to
a remote Node.

Some more specific changes:

  • Remove Details box re: Node Tunneling: This isn't strictly relevant
    to Trusted Clusters, so removing it shortens and simplifies what is
    quite a long guide.

  • Make "How Trusted Clusters work" more concise and add the information
    to the introduction.

  • Move long explanatory passages into Details boxes. Eventually, it
    would be great to split this guide into multiple guides that explain
    different topics in more depth (e.g., a section of the docs devoted
    to Trusted Clusters). For now, this is the quickest way to organize
    conceptual information without detracting from the tutorial structure.

@ptgott ptgott enabled auto-merge (squash) June 22, 2022 15:00
Backports #10708

* Edit the Trusted Clusters guide for Cloud

See #10633

- Misc style/grammar/clarity tweaks
- Turn the Teleport Node Tunneling Admonition into a Details
  box so it can be invisible for Cloud users. In Cloud, Nodes
  must connect via Node Tunneling.
- Use Tabs components to add Cloud versions of CLI commands
- Only show the static join token method for self-hosted users
  via Tabs
- Use a Details box to show content relevant only for Enterprise
  and Cloud users
- Remove an Admonition that was duplicated in the Troubleshooting
  section

* Respond to PR feedback

* Address PR feedback

* Turn the Trusted Clusters guide into a tutorial

See: #11841

The Trusted Clusters guide is organized as a conceptual introduction,
with configuration/command snippets used as illustrations. To make this
guide easier to follow, I have structured it as a step-by-step tutorial
where a user should be able to copy each command/config snippet on
their own environment, establish trust between clusters, and connect to
a remote Node.

Some more specific changes:

- Remove Details box re: Node Tunneling: This isn't strictly relevant
  to Trusted Clusters, so removing it shortens and simplifies what is
  quite a long guide.

- Make "How Trusted Clusters work" more concise and add the information
  to the introduction.

- Move long explanatory passages into Details boxes. Eventually, it
  would be great to split this guide into multiple guides that explain
  different topics in more depth (e.g., a section of the docs devoted
  to Trusted Clusters). For now, this is the quickest way to organize
  conceptual information without detracting from the tutorial structure.
@ptgott ptgott force-pushed the paul.gottschling/10708-bp-v8 branch from 4fa3d58 to 3b44521 Compare June 22, 2022 15:00
@ptgott ptgott merged commit 33cd77c into branch/v8 Jun 22, 2022
@ptgott ptgott deleted the paul.gottschling/10708-bp-v8 branch November 3, 2022 21:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants