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

Clarify two guides and two intro pages #11913

Merged
merged 3 commits into from
Apr 18, 2022
Merged

Conversation

ptgott
Copy link
Contributor

@ptgott ptgott commented Apr 13, 2022

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.

@github-actions github-actions bot requested review from r0mant, xinding33 and zmb3 April 13, 2022 15:45
@ptgott ptgott changed the title Clarify three guides after following them. Clarify two guides and two intro pages Apr 13, 2022
@ptgott ptgott force-pushed the paul.gottschling/11841-1 branch from ba842df to 0f7b0d3 Compare April 13, 2022 15:46
Teleport cluster. You will learn how to run the `teleport` daemon, manage users
and resources, and troubleshoot any issues that arise.

If you already understand how to set up a Teleport cluster, you should consult
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit:

Suggested change
If you already understand how to set up a Teleport cluster, you should consult
If you already understand how to set up a Teleport cluster, consult

Set up single sign-on with GitHub.
</Tile>
<Tile href="./admin/adding-nodes.mdx" title="Adding Nodes" icon="wrench">
How to add Nodes to your Teleport cluster.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For consistency with how others are phrased:

Suggested change
How to add Nodes to your Teleport cluster.
Add nodes to your Teleport cluster.

### Using Node invitation tokens
### Start your Node with the invite token and CA pin

The CA pin at the needs to be passed to new Nodes when they're
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm having a hard time parsing "The CA pin at the needs to be passed ...". Is there a typo here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is—fixed

starting for the first time, i.e. when they join a cluster.

If a CA pin is not provided, the Teleport Node will join a cluster but it will
print a `WARN` message (warning).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
print a `WARN` message (warning).
print a warning message.

Backing up and restoring the cluster.
</Tile>
<Tile href="./operations/ca-rotation.mdx" title="CA Rotation" icon="wrench">
Rotating certificates and certificate authorities.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Rotating certificates and certificate authorities.
Rotating Teleport certificate authorities.

@ptgott ptgott force-pushed the paul.gottschling/11841-1 branch 2 times, most recently from ec9cd46 to cd1b42b Compare April 15, 2022 20:17
### Using Node invitation tokens
### Start your Node with the invite token and CA pin

A CA pin needs to be passed to new Nodes when they're starting for the first
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a little confusing, because we say it "needs to be passed to new nodes" and then immediately say it doesn't need to be provided to join a cluster.

@ptgott ptgott enabled auto-merge (squash) April 18, 2022 20:09
ptgott added 3 commits April 18, 2022 16:09
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.
Remove a misleading instruction re: CA pinning. Also move some text
about CA pinning to a more appropriate location.
@ptgott ptgott force-pushed the paul.gottschling/11841-1 branch from 9ae65db to e5c7361 Compare April 18, 2022 20:09
@ptgott ptgott merged commit 2d4dbbc into master Apr 18, 2022
@ptgott ptgott deleted the paul.gottschling/11841-1 branch April 18, 2022 20:14
ptgott added a commit that referenced this pull request Apr 19, 2022
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 a commit that referenced this pull request Apr 20, 2022
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 added a commit that referenced this pull request Apr 20, 2022
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 added a commit that referenced this pull request Apr 21, 2022
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 a commit that referenced this pull request Apr 21, 2022
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 added a commit that referenced this pull request Apr 21, 2022
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 added a commit that referenced this pull request Apr 21, 2022
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 added a commit that referenced this pull request Apr 21, 2022
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
@webvictim webvictim mentioned this pull request Jun 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants