Prepare docs guides in the /setup section for the Cloud #10633
Labels
Milestone
Comments
ptgott
added a commit
that referenced
this issue
Feb 28, 2022
Ensure that users of a particular scope don't see irrelevant info See #10633 GitHub SSO guide - Edit the tctl partial to show only scope-relevant info. - Use tabs in the Prerequisites - Light edits for clarity Adding Nodes - Use Tabs for prerequisites - Move sections specific to self-hosted deployments into Details boxes that are hidden for Cloud users - Use Tabs components to offer Cloud-specific alternatives to examples of commands that presuppose a self-hosted deployment - Misc clarity edits
ptgott
added a commit
that referenced
this issue
Mar 1, 2022
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
ptgott
added a commit
that referenced
this issue
Mar 1, 2022
Ensure that users of a particular scope don't see irrelevant info See #10633 GitHub SSO guide - Edit the tctl partial to show only scope-relevant info. - Use tabs in the Prerequisites - Light edits for clarity Adding Nodes - Use Tabs for prerequisites - Move sections specific to self-hosted deployments into Details boxes that are hidden for Cloud users - Use Tabs components to offer Cloud-specific alternatives to examples of commands that presuppose a self-hosted deployment - Misc clarity edits
ptgott
added a commit
that referenced
this issue
Mar 2, 2022
See #10633 Labels - Turn the Prerequisites into a Tabs box for different editions. This means that users of one edition will not need to see information intended for users of another edition. - Add misc. clarity, grammar, and style edits. Local Users - Use Tabs for the Prerequisites so users of one edition don't see information for another edition - SSO was briefly mentioned without elaboration, so I added this to a Further Reading section with scoped tabs - Use Tabs for Proxy connection instructions Troubleshooting - Add a note re: the relevance of the guide for Cloud users - Add Tabs for the Getting help section so commercial or OSS users don't see irrelevant information - General clarity, grammar, and style tweaks Graceful Restarts - Add a notice indicating how this guide is relevant for Cloud users - Misc clarity, grammar, and style tweaks
ptgott
added a commit
that referenced
this issue
Mar 3, 2022
See #10633 Upgrading - Misc. grammar/style/clarity tweaks - Add details re: checking the Cloud Proxy/Auth versions for Cloud users - Add a scoped Tabs component for the upgrade sequence - Remove the "upgrading to Teleport 4.0+" section since we no longer support this version Backup and restore - Add scoped Tabs components where instructions vary between editions - Misc clarity/grammar/style improvements Authentication Use Tabs to ensure that readers who have selected one scope don't see content that is relevant only for other scopes.
This was referenced Mar 3, 2022
ptgott
added a commit
that referenced
this issue
Mar 7, 2022
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
ptgott
added a commit
that referenced
this issue
Mar 9, 2022
TLS Routing Migration Added a compatibility note for Cloud users. Unfortunately there is nothing else we can do until we can come up with a way to adjust the visibility of whole pages based on the scope picker. Running Teleport on GCP and IBM Cloud Both of these guides assume throughout that you are deploying the Auth Service, Proxy Service, and Auth Service storage backend. There is very little relevant information for Cloud users. Since making these guides relevant for Cloud users would require research and rewriting, which is out of scope for issue #10633, this change adds a Notice component to these guides explaining their relevance. Reducing the Blast Radius This guide already includes instructions for Cloud users. This change includes the tctl.mdx partial to ensure that Cloud users know to log in first before running tctl commands. Resources reference - Add Tabs in the introduction where guidance differs for Cloud and Self-Hosted users. - Include the tctl.mdx partial in the Introduction so users know how to connect to their Teleport cluster in order to perform tctl commands. - Edit the introductory sections of the post for clarity and style. Note that this change does not attempt to fill in missing dynamic resource types within the reference list, as this would be outside the time I allotted to work on issue #10633. CLI reference - Add instructions for Cloud users via a Notice above the roles table and tabbed instructions above the tctl section. - Add an entry for the Windows Desktop Service in the roles table. - Perform some light copy editing, e.g., removing somewhat confusing links from H4 headings and making minor style tweaks. A comprehensive refresh of the CLI reference is out of scope of my work on issue #10633.
ptgott
added a commit
that referenced
this issue
Mar 9, 2022
Ensure that users of a particular scope don't see irrelevant info See #10633 GitHub SSO guide - Edit the tctl partial to show only scope-relevant info. - Use tabs in the Prerequisites - Light edits for clarity Adding Nodes - Use Tabs for prerequisites - Move sections specific to self-hosted deployments into Details boxes that are hidden for Cloud users - Use Tabs components to offer Cloud-specific alternatives to examples of commands that presuppose a self-hosted deployment - Misc clarity edits
ptgott
added a commit
that referenced
this issue
Mar 9, 2022
See #10633 Labels - Turn the Prerequisites into a Tabs box for different editions. This means that users of one edition will not need to see information intended for users of another edition. - Add misc. clarity, grammar, and style edits. Local Users - Use Tabs for the Prerequisites so users of one edition don't see information for another edition - SSO was briefly mentioned without elaboration, so I added this to a Further Reading section with scoped tabs - Use Tabs for Proxy connection instructions Troubleshooting - Add a note re: the relevance of the guide for Cloud users - Add Tabs for the Getting help section so commercial or OSS users don't see irrelevant information - General clarity, grammar, and style tweaks Graceful Restarts - Add a notice indicating how this guide is relevant for Cloud users - Misc clarity, grammar, and style tweaks
ptgott
added a commit
that referenced
this issue
Mar 9, 2022
See #10633 Upgrading - Misc. grammar/style/clarity tweaks - Add details re: checking the Cloud Proxy/Auth versions for Cloud users - Add a scoped Tabs component for the upgrade sequence - Remove the "upgrading to Teleport 4.0+" section since we no longer support this version Backup and restore - Add scoped Tabs components where instructions vary between editions - Misc clarity/grammar/style improvements Authentication Use Tabs to ensure that readers who have selected one scope don't see content that is relevant only for other scopes.
ptgott
added a commit
that referenced
this issue
Mar 10, 2022
Ensure that users of a particular scope don't see irrelevant info See #10633 GitHub SSO guide - Edit the tctl partial to show only scope-relevant info. - Use tabs in the Prerequisites - Light edits for clarity Adding Nodes - Use Tabs for prerequisites - Move sections specific to self-hosted deployments into Details boxes that are hidden for Cloud users - Use Tabs components to offer Cloud-specific alternatives to examples of commands that presuppose a self-hosted deployment - Misc clarity edits
ptgott
added a commit
that referenced
this issue
Apr 14, 2022
Backports #10801 * Edit three guides to support Cloud users See #10633 Upgrading - Misc. grammar/style/clarity tweaks - Add details re: checking the Cloud Proxy/Auth versions for Cloud users - Add a scoped Tabs component for the upgrade sequence - Remove the "upgrading to Teleport 4.0+" section since we no longer support this version Backup and restore - Add scoped Tabs components where instructions vary between editions - Misc clarity/grammar/style improvements Authentication Use Tabs to ensure that readers who have selected one scope don't see content that is relevant only for other scopes. * Respond to PR feedback
ptgott
added a commit
that referenced
this issue
Apr 14, 2022
Backports #10801 * Edit three guides to support Cloud users See #10633 Upgrading - Misc. grammar/style/clarity tweaks - Add details re: checking the Cloud Proxy/Auth versions for Cloud users - Add a scoped Tabs component for the upgrade sequence - Remove the "upgrading to Teleport 4.0+" section since we no longer support this version Backup and restore - Add scoped Tabs components where instructions vary between editions - Misc clarity/grammar/style improvements Authentication Use Tabs to ensure that readers who have selected one scope don't see content that is relevant only for other scopes. * Respond to PR feedback
ptgott
added a commit
that referenced
this issue
Apr 15, 2022
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
ptgott
added a commit
that referenced
this issue
Apr 15, 2022
Backports #10996 * Prepare more Setup guides for Cloud users Running Teleport on GCP and IBM Cloud Both of these guides assume throughout that you are deploying the Auth Service, Proxy Service, and Auth Service storage backend. There is very little relevant information for Cloud users. Since making these guides relevant for Cloud users would require research and rewriting, which is out of scope for issue #10633, this change adds a Notice component to these guides explaining their relevance. Resources reference - Add Tabs in the introduction where guidance differs for Cloud and Self-Hosted users. - Include the tctl.mdx partial in the Introduction so users know how to connect to their Teleport cluster in order to perform tctl commands. - Edit the introductory sections of the post for clarity and style. Note that this change does not attempt to fill in missing dynamic resource types within the reference list, as this would be outside the time I allotted to work on issue #10633. CLI reference - Add instructions for Cloud users via a Notice above the roles table and tabbed instructions above the tctl section. - Add an entry for the Windows Desktop Service in the roles table. - Perform some light copy editing, e.g., removing somewhat confusing links from H4 headings and making minor style tweaks. A comprehensive refresh of the CLI reference is out of scope of my work on issue #10633. * Respond to PR feedback
ptgott
added a commit
that referenced
this issue
Apr 15, 2022
Backports #10996 * Prepare more Setup guides for Cloud users Running Teleport on GCP and IBM Cloud Both of these guides assume throughout that you are deploying the Auth Service, Proxy Service, and Auth Service storage backend. There is very little relevant information for Cloud users. Since making these guides relevant for Cloud users would require research and rewriting, which is out of scope for issue #10633, this change adds a Notice component to these guides explaining their relevance. Resources reference - Add Tabs in the introduction where guidance differs for Cloud and Self-Hosted users. - Include the tctl.mdx partial in the Introduction so users know how to connect to their Teleport cluster in order to perform tctl commands. - Edit the introductory sections of the post for clarity and style. Note that this change does not attempt to fill in missing dynamic resource types within the reference list, as this would be outside the time I allotted to work on issue #10633. CLI reference - Add instructions for Cloud users via a Notice above the roles table and tabbed instructions above the tctl section. - Add an entry for the Windows Desktop Service in the roles table. - Perform some light copy editing, e.g., removing somewhat confusing links from H4 headings and making minor style tweaks. A comprehensive refresh of the CLI reference is out of scope of my work on issue #10633. * Respond to PR feedback
ptgott
added a commit
that referenced
this issue
Apr 15, 2022
See #10633 Upgrading - Misc. grammar/style/clarity tweaks - Add details re: checking the Cloud Proxy/Auth versions for Cloud users - Add a scoped Tabs component for the upgrade sequence - Remove the "upgrading to Teleport 4.0+" section since we no longer support this version Backup and restore - Add scoped Tabs components where instructions vary between editions - Misc clarity/grammar/style improvements Authentication Use Tabs to ensure that readers who have selected one scope don't see content that is relevant only for other scopes.
ptgott
added a commit
that referenced
this issue
Apr 15, 2022
* Edit three guides to support Cloud users See #10633 Upgrading - Misc. grammar/style/clarity tweaks - Add details re: checking the Cloud Proxy/Auth versions for Cloud users - Add a scoped Tabs component for the upgrade sequence - Remove the "upgrading to Teleport 4.0+" section since we no longer support this version Backup and restore - Add scoped Tabs components where instructions vary between editions - Misc clarity/grammar/style improvements Authentication Use Tabs to ensure that readers who have selected one scope don't see content that is relevant only for other scopes. * Respond to PR feedback * Respond to PR feedback
ptgott
added a commit
that referenced
this issue
Apr 15, 2022
TLS Routing Migration Added a compatibility note for Cloud users. Unfortunately there is nothing else we can do until we can come up with a way to adjust the visibility of whole pages based on the scope picker. Running Teleport on GCP and IBM Cloud Both of these guides assume throughout that you are deploying the Auth Service, Proxy Service, and Auth Service storage backend. There is very little relevant information for Cloud users. Since making these guides relevant for Cloud users would require research and rewriting, which is out of scope for issue #10633, this change adds a Notice component to these guides explaining their relevance. Reducing the Blast Radius This guide already includes instructions for Cloud users. This change includes the tctl.mdx partial to ensure that Cloud users know to log in first before running tctl commands. Resources reference - Add Tabs in the introduction where guidance differs for Cloud and Self-Hosted users. - Include the tctl.mdx partial in the Introduction so users know how to connect to their Teleport cluster in order to perform tctl commands. - Edit the introductory sections of the post for clarity and style. Note that this change does not attempt to fill in missing dynamic resource types within the reference list, as this would be outside the time I allotted to work on issue #10633. CLI reference - Add instructions for Cloud users via a Notice above the roles table and tabbed instructions above the tctl section. - Add an entry for the Windows Desktop Service in the roles table. - Perform some light copy editing, e.g., removing somewhat confusing links from H4 headings and making minor style tweaks. A comprehensive refresh of the CLI reference is out of scope of my work on issue #10633.
ptgott
added a commit
that referenced
this issue
Apr 15, 2022
* Prepare more Setup guides for Cloud users TLS Routing Migration Added a compatibility note for Cloud users. Unfortunately there is nothing else we can do until we can come up with a way to adjust the visibility of whole pages based on the scope picker. Running Teleport on GCP and IBM Cloud Both of these guides assume throughout that you are deploying the Auth Service, Proxy Service, and Auth Service storage backend. There is very little relevant information for Cloud users. Since making these guides relevant for Cloud users would require research and rewriting, which is out of scope for issue #10633, this change adds a Notice component to these guides explaining their relevance. Reducing the Blast Radius This guide already includes instructions for Cloud users. This change includes the tctl.mdx partial to ensure that Cloud users know to log in first before running tctl commands. Resources reference - Add Tabs in the introduction where guidance differs for Cloud and Self-Hosted users. - Include the tctl.mdx partial in the Introduction so users know how to connect to their Teleport cluster in order to perform tctl commands. - Edit the introductory sections of the post for clarity and style. Note that this change does not attempt to fill in missing dynamic resource types within the reference list, as this would be outside the time I allotted to work on issue #10633. CLI reference - Add instructions for Cloud users via a Notice above the roles table and tabbed instructions above the tctl section. - Add an entry for the Windows Desktop Service in the roles table. - Perform some light copy editing, e.g., removing somewhat confusing links from H4 headings and making minor style tweaks. A comprehensive refresh of the CLI reference is out of scope of my work on issue #10633. * Respond to PR feedback * Address PR feedback
ptgott
added a commit
that referenced
this issue
Apr 18, 2022
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
ptgott
added a commit
that referenced
this issue
Apr 19, 2022
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
ptgott
added a commit
that referenced
this issue
Apr 20, 2022
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
|
This issue will be resolved once we merge #10708. |
ptgott
added a commit
that referenced
this issue
Apr 26, 2022
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
ptgott
added a commit
that referenced
this issue
May 5, 2022
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
ptgott
added a commit
that referenced
this issue
May 9, 2022
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
ptgott
added a commit
that referenced
this issue
May 24, 2022
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
ptgott
added a commit
that referenced
this issue
Jun 6, 2022
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
ptgott
added a commit
that referenced
this issue
Jun 6, 2022
…ent scopes) (#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
added a commit
that referenced
this issue
Jun 7, 2022
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
ptgott
added a commit
that referenced
this issue
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.
|
This issue has been resolved. |
ptgott
added a commit
that referenced
this issue
Jun 22, 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
added a commit
that referenced
this issue
Jun 22, 2022
Convert the Trusted Clusters guide to a tutorial 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
added a commit
that referenced
this issue
Jun 22, 2022
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
ptgott
added a commit
that referenced
this issue
Jun 22, 2022
* 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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Details
As explained in #10631, we want to edit docs pages in high-priority sections to show only relevant information to users who have selected "Cloud" in the scope switcher. This issue focuses on the Setup section.
Pages to edit
I generated a table of pages to edit by running the following script from the root of my
gravitational/teleportrepo clone:Here is the output:
Category
The text was updated successfully, but these errors were encountered: