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

[v9 backport] Edit two guides for Cloud users #11642

Merged
merged 1 commit into from
Apr 1, 2022

Conversation

ptgott
Copy link
Contributor

@ptgott ptgott commented Mar 31, 2022

Backports #11470

  • Edit two guides for Cloud users

(1) Server Access Getting Started

While this guide mentions Teleport Cloud throughout, I wanted to make
sure that users of one edition wouldn't see scope-irrelevant details.

  • Add scoped Tabs to the Prerequisites section
  • Add the scoped "tctl.mdx" Details box
  • Add ScopedBlocks for minor scope-relevant details like the address
    of the Proxy Service
  • Edit the tctl.mdx partial to mention when you would use sudo to run
    tctl on a local machine, a detail that was added to this guide but
    could be included in any guide that uses the tctl.mdx partial.

Also makes misc. style, grammar, and clarity edits.

(2) Edit the OpenSSH guide and spin off a PRM guide

  • The Recording Proxy Mode instructions don't apply to Cloud users.
    I didn't want to use a ScopedBlock to hide the relevant H2s, since
    these still appear within a page's table of contents. Instead, I
    separated the Recording Proxy Mode instructions into their own guide,
    and added an edition warning for Cloud users at the top of the guide.

    I also did some restructuring of the OpenSSH guide to clean it up after
    separating the Recording Proxy Mode instructions.

  • Used ScopedBlocks to ensure that only scope-relevant information is
    shown in the OpenSSH guide.

  • Misc grammar/style/clarity tweaks

  • Respond to PR feedback

@ptgott ptgott enabled auto-merge (squash) April 1, 2022 19:25
Backports #11470

* Edit two guides for Cloud users

(1) Server Access Getting Started

While this guide mentions Teleport Cloud throughout, I wanted to make
sure that users of one edition wouldn't see scope-irrelevant details.

- Add scoped Tabs to the Prerequisites section
- Add the scoped "tctl.mdx" Details box
- Add ScopedBlocks for minor scope-relevant details like the address
  of the Proxy Service
- Edit the tctl.mdx partial to mention when you would use sudo to run
  tctl on a local machine, a detail that was added to this guide but
  could be included in any guide that uses the tctl.mdx partial.

Also makes misc. style, grammar, and clarity edits.

(2) Edit the OpenSSH guide and spin off a PRM guide

- The Recording Proxy Mode instructions don't apply to Cloud users.
  I didn't want to use a ScopedBlock to hide the relevant H2s, since
  these still appear within a page's table of contents. Instead, I
  separated the Recording Proxy Mode instructions into their own guide,
  and added an edition warning for Cloud users at the top of the guide.

  I also did some restructuring of the OpenSSH guide to clean it up after
  separating the Recording Proxy Mode instructions.

- Used ScopedBlocks to ensure that only scope-relevant information is
  shown in the OpenSSH guide.

- Misc grammar/style/clarity tweaks

* Respond to PR feedback
@ptgott ptgott force-pushed the paul.gottschling/11470-bp-v9 branch from 89a1585 to 4e62456 Compare April 1, 2022 19:25
@ptgott ptgott merged commit 841e107 into branch/v9 Apr 1, 2022
@ptgott ptgott deleted the paul.gottschling/11470-bp-v9 branch April 1, 2022 19:31
@webvictim webvictim mentioned this pull request Apr 19, 2022
@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