Prepare Access Controls docs pages for the Cloud #10638

ptgott · 2022-02-25T19:05:57Z

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 Access Controls section.

Pages to edit

I generated a table of pages to edit by running the following script from the root of my gravitational/teleport repo clone:

$ echo "|Slug|PR|" && echo "|---|---|" && cat docs/config.json | jq '.navigation[] | select(.title=="Access Controls").entries[] | recurse(.entries[]?) | .slug' | sed -E 's/(^.*$)/|\1||/'

Here is the output:

Slug	PR
"/access-controls/introduction/"	Menu page: no changes needed
"/access-controls/getting-started/"	#11826
"/access-controls/guides/"	Menu page: no changes needed
"/access-controls/guides/role-templates/"	#11826
"/access-controls/guides/locking/"	#11826
"/access-controls/guides/webauthn/"	#11826
"/access-controls/guides/per-session-mfa/"	#11838
"/access-controls/guides/dual-authz/"	#11838
"/access-controls/guides/impersonation/"	#11838
"/access-controls/guides/moderated-sessions/"	#11838
"/access-controls/reference/"	N/A: no scope-irrelevant information
"/access-controls/faq/"	N/A: no scope-irrelevant information

Category

Improve Existing

The text was updated successfully, but these errors were encountered:

See #10638 Access Controls Getting Started guide - Add a tabbed Prerequisites section for users of different scopes - Use a ScopedBlock to show OIDC and SAML instructions as Tabs for commercial Teleport users and GitHub instructions for OSS Teleport users - Light style/grammar/clarity edits Role Templates - Tabbed Prerequisites section for different scopes - Adjust the visibility of minor details using ScopedBlocks Locking - Add a scoped Tabs component to the Prerequisites section - Add a ScopedBlock to hide CLI- and config file-specific instructions from Cloud users. WebAuthn - Add scoped Tabs to the Prerequisites section - Move Tabs with TabItems for static configurations and dynamic resources into ScopedBlocks. This way, we don't have to show static configuration instructions to Cloud users. - Remove duplicate config field explanations. - Minor style/grammar edits

See #10638 Per-session MFA - Add scoped Tabs to the Prerequisites section - Add a ScopedBlock so Cloud users don't see the option to enable per-session MFA via static config - Minor copy-edits and organization edits. For example, turn a section that refers to an example in another section into an Admonition. Dual Authorization - Add scoped Tabs to the Prerequisites - Use a scoped Notice for the edition warning - Style/clarity/grammar edits - Hide the Troubleshooting section for Cloud users Moderated Sessions - Change the edition warning to a scoped Notice. Since this guide is a conceptual guide rather than a step-by-step tutorial, there's no other scope-irrelevant information to hide. Impersonation - Add scoped Tabs to the Prerequisites - Used ScopedBlocks to hide minor scope-irrelevant details - Minor style/grammar/clarity edits

See #10638 Access Controls Getting Started guide - Add a tabbed Prerequisites section for users of different scopes - Use a ScopedBlock to show OIDC and SAML instructions as Tabs for commercial Teleport users and GitHub instructions for OSS Teleport users - Light style/grammar/clarity edits Role Templates - Tabbed Prerequisites section for different scopes - Adjust the visibility of minor details using ScopedBlocks Locking - Add a scoped Tabs component to the Prerequisites section - Add a ScopedBlock to hide CLI- and config file-specific instructions from Cloud users. WebAuthn - Add scoped Tabs to the Prerequisites section - Move Tabs with TabItems for static configurations and dynamic resources into ScopedBlocks. This way, we don't have to show static configuration instructions to Cloud users. - Remove duplicate config field explanations. - Minor style/grammar edits

See #10638 Per-session MFA - Add scoped Tabs to the Prerequisites section - Add a ScopedBlock so Cloud users don't see the option to enable per-session MFA via static config - Minor copy-edits and organization edits. For example, turn a section that refers to an example in another section into an Admonition. Dual Authorization - Add scoped Tabs to the Prerequisites - Use a scoped Notice for the edition warning - Style/clarity/grammar edits - Hide the Troubleshooting section for Cloud users Moderated Sessions - Change the edition warning to a scoped Notice. Since this guide is a conceptual guide rather than a step-by-step tutorial, there's no other scope-irrelevant information to hide. Impersonation - Add scoped Tabs to the Prerequisites - Used ScopedBlocks to hide minor scope-irrelevant details - Minor style/grammar/clarity edits

* Edit four Access Controls guides for Cloud users See #10638 Per-session MFA - Add scoped Tabs to the Prerequisites section - Add a ScopedBlock so Cloud users don't see the option to enable per-session MFA via static config - Minor copy-edits and organization edits. For example, turn a section that refers to an example in another section into an Admonition. Dual Authorization - Add scoped Tabs to the Prerequisites - Use a scoped Notice for the edition warning - Style/clarity/grammar edits - Hide the Troubleshooting section for Cloud users Moderated Sessions - Change the edition warning to a scoped Notice. Since this guide is a conceptual guide rather than a step-by-step tutorial, there's no other scope-irrelevant information to hide. Impersonation - Add scoped Tabs to the Prerequisites - Used ScopedBlocks to hide minor scope-irrelevant details - Minor style/grammar/clarity edits * Respond to PR feedback * Respond to PR feedback

See #10638 Access Controls Getting Started guide - Add a tabbed Prerequisites section for users of different scopes - Use a ScopedBlock to show OIDC and SAML instructions as Tabs for commercial Teleport users and GitHub instructions for OSS Teleport users - Light style/grammar/clarity edits Role Templates - Tabbed Prerequisites section for different scopes - Adjust the visibility of minor details using ScopedBlocks Locking - Add a scoped Tabs component to the Prerequisites section - Add a ScopedBlock to hide CLI- and config file-specific instructions from Cloud users. WebAuthn - Add scoped Tabs to the Prerequisites section - Move Tabs with TabItems for static configurations and dynamic resources into ScopedBlocks. This way, we don't have to show static configuration instructions to Cloud users. - Remove duplicate config field explanations. - Minor style/grammar edits

Backports #11838 * Edit four Access Controls guides for Cloud users See #10638 Per-session MFA - Add scoped Tabs to the Prerequisites section - Add a ScopedBlock so Cloud users don't see the option to enable per-session MFA via static config - Minor copy-edits and organization edits. For example, turn a section that refers to an example in another section into an Admonition. Dual Authorization - Add scoped Tabs to the Prerequisites - Use a scoped Notice for the edition warning - Style/clarity/grammar edits - Hide the Troubleshooting section for Cloud users Moderated Sessions - Change the edition warning to a scoped Notice. Since this guide is a conceptual guide rather than a step-by-step tutorial, there's no other scope-irrelevant information to hide. Impersonation - Add scoped Tabs to the Prerequisites - Used ScopedBlocks to hide minor scope-irrelevant details - Minor style/grammar/clarity edits * Respond to PR feedback * Respond to PR feedback

See #10638 Access Controls Getting Started guide - Add a tabbed Prerequisites section for users of different scopes - Use a ScopedBlock to show OIDC and SAML instructions as Tabs for commercial Teleport users and GitHub instructions for OSS Teleport users - Light style/grammar/clarity edits Role Templates - Tabbed Prerequisites section for different scopes - Adjust the visibility of minor details using ScopedBlocks Locking - Add a scoped Tabs component to the Prerequisites section - Add a ScopedBlock to hide CLI- and config file-specific instructions from Cloud users. WebAuthn - Add scoped Tabs to the Prerequisites section - Move Tabs with TabItems for static configurations and dynamic resources into ScopedBlocks. This way, we don't have to show static configuration instructions to Cloud users. - Remove duplicate config field explanations. - Minor style/grammar edits

* Edit four Access Controls pages for Cloud users See #10638 Access Controls Getting Started guide - Add a tabbed Prerequisites section for users of different scopes - Use a ScopedBlock to show OIDC and SAML instructions as Tabs for commercial Teleport users and GitHub instructions for OSS Teleport users - Light style/grammar/clarity edits Role Templates - Tabbed Prerequisites section for different scopes - Adjust the visibility of minor details using ScopedBlocks Locking - Add a scoped Tabs component to the Prerequisites section - Add a ScopedBlock to hide CLI- and config file-specific instructions from Cloud users. WebAuthn - Add scoped Tabs to the Prerequisites section - Move Tabs with TabItems for static configurations and dynamic resources into ScopedBlocks. This way, we don't have to show static configuration instructions to Cloud users. - Remove duplicate config field explanations. - Minor style/grammar edits * Respond to PR feedback - Change verbiage re: belonging to a role - Remove U2F migration section

Clarify two guides and two intro pages Backports #11913 * Clarify two guides and two intro pages See #11841 Make the Adding Nodes guide more usable for Cloud - Add a ca_pin preset - Clarify that tctl must be run on the local machine for Cloud users - Structure the guide as a step-by-step tutorial. The guide already included sequences of sample commands, so all this took was to rename headings according to the "Step n/d." format and move the CA pinning section into the section on starting the Node. - Add environment variables to use for storing a CA pin and invite token to sample commands, plus piped commands to extract these strings from the output of tctl commands. - Use a ScopedBlock to hide the Node Tunneling section for Cloud users - Indicate that the --auth-server flag in "teleport start" requires a port. Add intros to the Admin and Operations menu pages - Clarify the purpose of the Admin Guides and Operations sections by adding an intro paragraph to each page. Since these sections are similar in scope, I added links from one to the other with statements about how the two sections differ. - Replace lists of links with Tiles. GitHub SSO - Move the step to create an OAuth app out of the Prerequisites and into its own step. This makes it easier to give the instructions to use a specific callback URL proper space. - Be more explicit about the rp_ip value. - Add explicit instructions for logging in to the cluster after creating the auth preference, including screenshots of expected results. * Fix wording and linter issues following PR review * Respond to PR feedback Remove a misleading instruction re: CA pinning. Also move some text about CA pinning to a more appropriate location. Edit four Access Controls pages for Cloud users Backports #11826 * Edit four Access Controls pages for Cloud users See #10638 Access Controls Getting Started guide - Add a tabbed Prerequisites section for users of different scopes - Use a ScopedBlock to show OIDC and SAML instructions as Tabs for commercial Teleport users and GitHub instructions for OSS Teleport users - Light style/grammar/clarity edits Role Templates - Tabbed Prerequisites section for different scopes - Adjust the visibility of minor details using ScopedBlocks Locking - Add a scoped Tabs component to the Prerequisites section - Add a ScopedBlock to hide CLI- and config file-specific instructions from Cloud users. WebAuthn - Add scoped Tabs to the Prerequisites section - Move Tabs with TabItems for static configurations and dynamic resources into ScopedBlocks. This way, we don't have to show static configuration instructions to Cloud users. - Remove duplicate config field explanations. - Minor style/grammar edits * Respond to PR feedback - Change verbiage re: belonging to a role - Remove U2F migration section

Backports #11419 * Edit two guides for Cloud users PAM guide - Minor style/clarity/grammar edits - Use a ScopedBlock to hide Cloud-irrelevant information in the MOTD section - The organization of the original guide was a bit scrambled, so I attempted to reorganize it into a form that made more sense. Tsh guide - Use ScopedBlocks to provide scope-relevant information. - Mention Machine ID in the "### SSH certificates for automation" section. - Misc grammar/clarity/style edits * Respond to PR feedback Clarify two guides and two intro pages Backports #11913 * Clarify two guides and two intro pages See #11841 Make the Adding Nodes guide more usable for Cloud - Add a ca_pin preset - Clarify that tctl must be run on the local machine for Cloud users - Structure the guide as a step-by-step tutorial. The guide already included sequences of sample commands, so all this took was to rename headings according to the "Step n/d." format and move the CA pinning section into the section on starting the Node. - Add environment variables to use for storing a CA pin and invite token to sample commands, plus piped commands to extract these strings from the output of tctl commands. - Use a ScopedBlock to hide the Node Tunneling section for Cloud users - Indicate that the --auth-server flag in "teleport start" requires a port. Add intros to the Admin and Operations menu pages - Clarify the purpose of the Admin Guides and Operations sections by adding an intro paragraph to each page. Since these sections are similar in scope, I added links from one to the other with statements about how the two sections differ. - Replace lists of links with Tiles. GitHub SSO - Move the step to create an OAuth app out of the Prerequisites and into its own step. This makes it easier to give the instructions to use a specific callback URL proper space. - Be more explicit about the rp_ip value. - Add explicit instructions for logging in to the cluster after creating the auth preference, including screenshots of expected results. * Fix wording and linter issues following PR review * Respond to PR feedback Remove a misleading instruction re: CA pinning. Also move some text about CA pinning to a more appropriate location. Edit four Access Controls pages for Cloud users Backports #11826 * Edit four Access Controls pages for Cloud users See #10638 Access Controls Getting Started guide - Add a tabbed Prerequisites section for users of different scopes - Use a ScopedBlock to show OIDC and SAML instructions as Tabs for commercial Teleport users and GitHub instructions for OSS Teleport users - Light style/grammar/clarity edits Role Templates - Tabbed Prerequisites section for different scopes - Adjust the visibility of minor details using ScopedBlocks Locking - Add a scoped Tabs component to the Prerequisites section - Add a ScopedBlock to hide CLI- and config file-specific instructions from Cloud users. WebAuthn - Add scoped Tabs to the Prerequisites section - Move Tabs with TabItems for static configurations and dynamic resources into ScopedBlocks. This way, we don't have to show static configuration instructions to Cloud users. - Remove duplicate config field explanations. - Minor style/grammar edits * Respond to PR feedback - Change verbiage re: belonging to a role - Remove U2F migration section

Edit two guides for Cloud users Backports #11419 * Edit two guides for Cloud users PAM guide - Minor style/clarity/grammar edits - Use a ScopedBlock to hide Cloud-irrelevant information in the MOTD section - The organization of the original guide was a bit scrambled, so I attempted to reorganize it into a form that made more sense. Tsh guide - Use ScopedBlocks to provide scope-relevant information. - Mention Machine ID in the "### SSH certificates for automation" section. - Misc grammar/clarity/style edits * Respond to PR feedback Clarify two guides and two intro pages Backports #11913 * Clarify two guides and two intro pages See #11841 Make the Adding Nodes guide more usable for Cloud - Add a ca_pin preset - Clarify that tctl must be run on the local machine for Cloud users - Structure the guide as a step-by-step tutorial. The guide already included sequences of sample commands, so all this took was to rename headings according to the "Step n/d." format and move the CA pinning section into the section on starting the Node. - Add environment variables to use for storing a CA pin and invite token to sample commands, plus piped commands to extract these strings from the output of tctl commands. - Use a ScopedBlock to hide the Node Tunneling section for Cloud users - Indicate that the --auth-server flag in "teleport start" requires a port. Add intros to the Admin and Operations menu pages - Clarify the purpose of the Admin Guides and Operations sections by adding an intro paragraph to each page. Since these sections are similar in scope, I added links from one to the other with statements about how the two sections differ. - Replace lists of links with Tiles. GitHub SSO - Move the step to create an OAuth app out of the Prerequisites and into its own step. This makes it easier to give the instructions to use a specific callback URL proper space. - Be more explicit about the rp_ip value. - Add explicit instructions for logging in to the cluster after creating the auth preference, including screenshots of expected results. * Fix wording and linter issues following PR review * Respond to PR feedback Remove a misleading instruction re: CA pinning. Also move some text about CA pinning to a more appropriate location. Edit four Access Controls pages for Cloud users Backports #11826 * Edit four Access Controls pages for Cloud users See #10638 Access Controls Getting Started guide - Add a tabbed Prerequisites section for users of different scopes - Use a ScopedBlock to show OIDC and SAML instructions as Tabs for commercial Teleport users and GitHub instructions for OSS Teleport users - Light style/grammar/clarity edits Role Templates - Tabbed Prerequisites section for different scopes - Adjust the visibility of minor details using ScopedBlocks Locking - Add a scoped Tabs component to the Prerequisites section - Add a ScopedBlock to hide CLI- and config file-specific instructions from Cloud users. WebAuthn - Add scoped Tabs to the Prerequisites section - Move Tabs with TabItems for static configurations and dynamic resources into ScopedBlocks. This way, we don't have to show static configuration instructions to Cloud users. - Remove duplicate config field explanations. - Minor style/grammar edits * Respond to PR feedback - Change verbiage re: belonging to a role - Remove U2F migration section

ptgott · 2022-04-20T20:36:56Z

All linked PRs have been merged.

Clarify two guides and two intro pages Backports #11913 * Clarify two guides and two intro pages See #11841 Make the Adding Nodes guide more usable for Cloud - Add a ca_pin preset - Clarify that tctl must be run on the local machine for Cloud users - Structure the guide as a step-by-step tutorial. The guide already included sequences of sample commands, so all this took was to rename headings according to the "Step n/d." format and move the CA pinning section into the section on starting the Node. - Add environment variables to use for storing a CA pin and invite token to sample commands, plus piped commands to extract these strings from the output of tctl commands. - Use a ScopedBlock to hide the Node Tunneling section for Cloud users - Indicate that the --auth-server flag in "teleport start" requires a port. Add intros to the Admin and Operations menu pages - Clarify the purpose of the Admin Guides and Operations sections by adding an intro paragraph to each page. Since these sections are similar in scope, I added links from one to the other with statements about how the two sections differ. - Replace lists of links with Tiles. GitHub SSO - Move the step to create an OAuth app out of the Prerequisites and into its own step. This makes it easier to give the instructions to use a specific callback URL proper space. - Be more explicit about the rp_ip value. - Add explicit instructions for logging in to the cluster after creating the auth preference, including screenshots of expected results. * Fix wording and linter issues following PR review * Respond to PR feedback Remove a misleading instruction re: CA pinning. Also move some text about CA pinning to a more appropriate location. Edit four Access Controls pages for Cloud users Backports #11826 * Edit four Access Controls pages for Cloud users See #10638 Access Controls Getting Started guide - Add a tabbed Prerequisites section for users of different scopes - Use a ScopedBlock to show OIDC and SAML instructions as Tabs for commercial Teleport users and GitHub instructions for OSS Teleport users - Light style/grammar/clarity edits Role Templates - Tabbed Prerequisites section for different scopes - Adjust the visibility of minor details using ScopedBlocks Locking - Add a scoped Tabs component to the Prerequisites section - Add a ScopedBlock to hide CLI- and config file-specific instructions from Cloud users. WebAuthn - Add scoped Tabs to the Prerequisites section - Move Tabs with TabItems for static configurations and dynamic resources into ScopedBlocks. This way, we don't have to show static configuration instructions to Cloud users. - Remove duplicate config field explanations. - Minor style/grammar edits * Respond to PR feedback - Change verbiage re: belonging to a role - Remove U2F migration section

Edit two guides for Cloud users Backports #11419 * Edit two guides for Cloud users PAM guide - Minor style/clarity/grammar edits - Use a ScopedBlock to hide Cloud-irrelevant information in the MOTD section - The organization of the original guide was a bit scrambled, so I attempted to reorganize it into a form that made more sense. Tsh guide - Use ScopedBlocks to provide scope-relevant information. - Mention Machine ID in the "### SSH certificates for automation" section. - Misc grammar/clarity/style edits * Respond to PR feedback Clarify two guides and two intro pages Backports #11913 * Clarify two guides and two intro pages See #11841 Make the Adding Nodes guide more usable for Cloud - Add a ca_pin preset - Clarify that tctl must be run on the local machine for Cloud users - Structure the guide as a step-by-step tutorial. The guide already included sequences of sample commands, so all this took was to rename headings according to the "Step n/d." format and move the CA pinning section into the section on starting the Node. - Add environment variables to use for storing a CA pin and invite token to sample commands, plus piped commands to extract these strings from the output of tctl commands. - Use a ScopedBlock to hide the Node Tunneling section for Cloud users - Indicate that the --auth-server flag in "teleport start" requires a port. Add intros to the Admin and Operations menu pages - Clarify the purpose of the Admin Guides and Operations sections by adding an intro paragraph to each page. Since these sections are similar in scope, I added links from one to the other with statements about how the two sections differ. - Replace lists of links with Tiles. GitHub SSO - Move the step to create an OAuth app out of the Prerequisites and into its own step. This makes it easier to give the instructions to use a specific callback URL proper space. - Be more explicit about the rp_ip value. - Add explicit instructions for logging in to the cluster after creating the auth preference, including screenshots of expected results. * Fix wording and linter issues following PR review * Respond to PR feedback Remove a misleading instruction re: CA pinning. Also move some text about CA pinning to a more appropriate location. Edit four Access Controls pages for Cloud users Backports #11826 * Edit four Access Controls pages for Cloud users See #10638 Access Controls Getting Started guide - Add a tabbed Prerequisites section for users of different scopes - Use a ScopedBlock to show OIDC and SAML instructions as Tabs for commercial Teleport users and GitHub instructions for OSS Teleport users - Light style/grammar/clarity edits Role Templates - Tabbed Prerequisites section for different scopes - Adjust the visibility of minor details using ScopedBlocks Locking - Add a scoped Tabs component to the Prerequisites section - Add a ScopedBlock to hide CLI- and config file-specific instructions from Cloud users. WebAuthn - Add scoped Tabs to the Prerequisites section - Move Tabs with TabItems for static configurations and dynamic resources into ScopedBlocks. This way, we don't have to show static configuration instructions to Cloud users. - Remove duplicate config field explanations. - Minor style/grammar edits * Respond to PR feedback - Change verbiage re: belonging to a role - Remove U2F migration section

Backports #11419 * Edit two guides for Cloud users PAM guide - Minor style/clarity/grammar edits - Use a ScopedBlock to hide Cloud-irrelevant information in the MOTD section - The organization of the original guide was a bit scrambled, so I attempted to reorganize it into a form that made more sense. Tsh guide - Use ScopedBlocks to provide scope-relevant information. - Mention Machine ID in the "### SSH certificates for automation" section. - Misc grammar/clarity/style edits * Respond to PR feedback Clarify two guides and two intro pages Backports #11913 * Clarify two guides and two intro pages See #11841 Make the Adding Nodes guide more usable for Cloud - Add a ca_pin preset - Clarify that tctl must be run on the local machine for Cloud users - Structure the guide as a step-by-step tutorial. The guide already included sequences of sample commands, so all this took was to rename headings according to the "Step n/d." format and move the CA pinning section into the section on starting the Node. - Add environment variables to use for storing a CA pin and invite token to sample commands, plus piped commands to extract these strings from the output of tctl commands. - Use a ScopedBlock to hide the Node Tunneling section for Cloud users - Indicate that the --auth-server flag in "teleport start" requires a port. Add intros to the Admin and Operations menu pages - Clarify the purpose of the Admin Guides and Operations sections by adding an intro paragraph to each page. Since these sections are similar in scope, I added links from one to the other with statements about how the two sections differ. - Replace lists of links with Tiles. GitHub SSO - Move the step to create an OAuth app out of the Prerequisites and into its own step. This makes it easier to give the instructions to use a specific callback URL proper space. - Be more explicit about the rp_ip value. - Add explicit instructions for logging in to the cluster after creating the auth preference, including screenshots of expected results. * Fix wording and linter issues following PR review * Respond to PR feedback Remove a misleading instruction re: CA pinning. Also move some text about CA pinning to a more appropriate location. Edit four Access Controls pages for Cloud users Backports #11826 * Edit four Access Controls pages for Cloud users See #10638 Access Controls Getting Started guide - Add a tabbed Prerequisites section for users of different scopes - Use a ScopedBlock to show OIDC and SAML instructions as Tabs for commercial Teleport users and GitHub instructions for OSS Teleport users - Light style/grammar/clarity edits Role Templates - Tabbed Prerequisites section for different scopes - Adjust the visibility of minor details using ScopedBlocks Locking - Add a scoped Tabs component to the Prerequisites section - Add a ScopedBlock to hide CLI- and config file-specific instructions from Cloud users. WebAuthn - Add scoped Tabs to the Prerequisites section - Move Tabs with TabItems for static configurations and dynamic resources into ScopedBlocks. This way, we don't have to show static configuration instructions to Cloud users. - Remove duplicate config field explanations. - Minor style/grammar edits * Respond to PR feedback - Change verbiage re: belonging to a role - Remove U2F migration section

Edit two guides for Cloud users Backports #11419 * Edit two guides for Cloud users PAM guide - Minor style/clarity/grammar edits - Use a ScopedBlock to hide Cloud-irrelevant information in the MOTD section - The organization of the original guide was a bit scrambled, so I attempted to reorganize it into a form that made more sense. Tsh guide - Use ScopedBlocks to provide scope-relevant information. - Mention Machine ID in the "### SSH certificates for automation" section. - Misc grammar/clarity/style edits * Respond to PR feedback Clarify two guides and two intro pages Backports #11913 * Clarify two guides and two intro pages See #11841 Make the Adding Nodes guide more usable for Cloud - Add a ca_pin preset - Clarify that tctl must be run on the local machine for Cloud users - Structure the guide as a step-by-step tutorial. The guide already included sequences of sample commands, so all this took was to rename headings according to the "Step n/d." format and move the CA pinning section into the section on starting the Node. - Add environment variables to use for storing a CA pin and invite token to sample commands, plus piped commands to extract these strings from the output of tctl commands. - Use a ScopedBlock to hide the Node Tunneling section for Cloud users - Indicate that the --auth-server flag in "teleport start" requires a port. Add intros to the Admin and Operations menu pages - Clarify the purpose of the Admin Guides and Operations sections by adding an intro paragraph to each page. Since these sections are similar in scope, I added links from one to the other with statements about how the two sections differ. - Replace lists of links with Tiles. GitHub SSO - Move the step to create an OAuth app out of the Prerequisites and into its own step. This makes it easier to give the instructions to use a specific callback URL proper space. - Be more explicit about the rp_ip value. - Add explicit instructions for logging in to the cluster after creating the auth preference, including screenshots of expected results. * Fix wording and linter issues following PR review * Respond to PR feedback Remove a misleading instruction re: CA pinning. Also move some text about CA pinning to a more appropriate location. Edit four Access Controls pages for Cloud users Backports #11826 * Edit four Access Controls pages for Cloud users See #10638 Access Controls Getting Started guide - Add a tabbed Prerequisites section for users of different scopes - Use a ScopedBlock to show OIDC and SAML instructions as Tabs for commercial Teleport users and GitHub instructions for OSS Teleport users - Light style/grammar/clarity edits Role Templates - Tabbed Prerequisites section for different scopes - Adjust the visibility of minor details using ScopedBlocks Locking - Add a scoped Tabs component to the Prerequisites section - Add a ScopedBlock to hide CLI- and config file-specific instructions from Cloud users. WebAuthn - Add scoped Tabs to the Prerequisites section - Move Tabs with TabItems for static configurations and dynamic resources into ScopedBlocks. This way, we don't have to show static configuration instructions to Cloud users. - Remove duplicate config field explanations. - Minor style/grammar edits * Respond to PR feedback - Change verbiage re: belonging to a role - Remove U2F migration section

Clarify two guides and two intro pages Backports #11913 * Clarify two guides and two intro pages See #11841 Make the Adding Nodes guide more usable for Cloud - Add a ca_pin preset - Clarify that tctl must be run on the local machine for Cloud users - Structure the guide as a step-by-step tutorial. The guide already included sequences of sample commands, so all this took was to rename headings according to the "Step n/d." format and move the CA pinning section into the section on starting the Node. - Add environment variables to use for storing a CA pin and invite token to sample commands, plus piped commands to extract these strings from the output of tctl commands. - Use a ScopedBlock to hide the Node Tunneling section for Cloud users - Indicate that the --auth-server flag in "teleport start" requires a port. Add intros to the Admin and Operations menu pages - Clarify the purpose of the Admin Guides and Operations sections by adding an intro paragraph to each page. Since these sections are similar in scope, I added links from one to the other with statements about how the two sections differ. - Replace lists of links with Tiles. GitHub SSO - Move the step to create an OAuth app out of the Prerequisites and into its own step. This makes it easier to give the instructions to use a specific callback URL proper space. - Be more explicit about the rp_ip value. - Add explicit instructions for logging in to the cluster after creating the auth preference, including screenshots of expected results. * Fix wording and linter issues following PR review * Respond to PR feedback Remove a misleading instruction re: CA pinning. Also move some text about CA pinning to a more appropriate location. Edit four Access Controls pages for Cloud users Backports #11826 * Edit four Access Controls pages for Cloud users See #10638 Access Controls Getting Started guide - Add a tabbed Prerequisites section for users of different scopes - Use a ScopedBlock to show OIDC and SAML instructions as Tabs for commercial Teleport users and GitHub instructions for OSS Teleport users - Light style/grammar/clarity edits Role Templates - Tabbed Prerequisites section for different scopes - Adjust the visibility of minor details using ScopedBlocks Locking - Add a scoped Tabs component to the Prerequisites section - Add a ScopedBlock to hide CLI- and config file-specific instructions from Cloud users. WebAuthn - Add scoped Tabs to the Prerequisites section - Move Tabs with TabItems for static configurations and dynamic resources into ScopedBlocks. This way, we don't have to show static configuration instructions to Cloud users. - Remove duplicate config field explanations. - Minor style/grammar edits * Respond to PR feedback - Change verbiage re: belonging to a role - Remove U2F migration section

ptgott added the documentation label Feb 25, 2022

ptgott mentioned this issue Feb 25, 2022

Prepare high-priority docs sections for Cloud users #10631

Closed

ptgott added this to the Docs Sprint: March 28, 2022 - April 8, 2022 milestone Mar 11, 2022

ptgott mentioned this issue Apr 8, 2022

Edit four Access Controls pages for Cloud users #11826

Merged

ptgott mentioned this issue Apr 8, 2022

Edit four Access Controls guides for Cloud users #11838

Merged

ptgott mentioned this issue Apr 14, 2022

[v9] Edit four Access Controls guides for Cloud users #11977

Merged

ptgott mentioned this issue Apr 14, 2022

[v8] Edit three Access Controls guides for Cloud users #11978

Merged

ptgott mentioned this issue Apr 14, 2022

[v7] Edit three Access Controls guides for Cloud users #11979

Merged

ptgott mentioned this issue Apr 19, 2022

v8 backports (#11419, #11913, #10638) #12092

Merged

ptgott mentioned this issue Apr 19, 2022

Backport #11419, #11913, and #10638 to v7 #12094

Merged

ptgott mentioned this issue Apr 19, 2022

Backport #11913 and #11826 to v9 #12095

Merged

ptgott closed this as completed Apr 20, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Prepare Access Controls docs pages for the Cloud #10638

Prepare Access Controls docs pages for the Cloud #10638

ptgott commented Feb 25, 2022 •

edited

Loading

ptgott commented Apr 20, 2022

Prepare Access Controls docs pages for the Cloud #10638

Prepare Access Controls docs pages for the Cloud #10638

Comments

ptgott commented Feb 25, 2022 • edited Loading

Details

Pages to edit

Category

ptgott commented Apr 20, 2022

ptgott commented Feb 25, 2022 •

edited

Loading