Make the Linux Server guide less SSH-centric#26309
Conversation
The current Linux Server guide includes instructions for accessing the server and viewing a session recording. For users who are not interested in server access, this can be irrelevant or even a turnoff. Instead of showing SSH-specific features, make the final step about registering resources using the Web UI.
Step 4 of the Linux Server guide, which instructs the user to log in to a cluster via `tsh`, breaks the user's focus from the Web UI unnecessarily. `tsh` isn't complex enough to require its own step in this guide. For users who would like CLI access to Teleport, this change includes the information as a Details box.
Use the term "enroll" instead.
ptgott
force-pushed
the
paul.gottschling/2023-05-15-linux-server-edit
branch
from
1be15dc to
6dd94ef
Compare
|
@rodgtr1 I incorporated some of your feedback in 6dd94ef . The feedback I haven't incorporated:
flowchart LR
subgraph private[Private network]
direction LR
serv1[Teleport service]
serv2[Teleport service]
serv3[Teleport service]
end
subgraph public[Public network]
Developers
end
subgraph server[Linux server]
direction RL
auth["Auth Service"]
proxy[Proxy Service]
ssh[SSH Service]
auth-- "Short-lived credentials" -->proxy
ssh-- Reverse tunnel-->proxy
end
Developers-- tsh sessions --->server
serv1 & serv2 & serv3-- Reverse tunnel--->server
|
There was a problem hiding this comment.
Since the light theme is now the default for Teleport 13, should we use that in new screenshots of the web UI?
|
@ptgott I think this PR is perfect, with the addition of Alex's suggestions. As for diagrams, what about something like this (would get Peter to make it look better). Or is this too basic, i.e. some more details added? Trying to keep it on par with the guide. 
|
- Remove image - Change language
|
@rodgtr1 What would you think of us working on the diagram in a subsequent PR? That way we can merge these easy-to-make changes and see what needs to be done in terms of getting a nice diagram together? |
Yes, lets do that in another PR |
|
@rodgtr1 Sounds good! Is there anything else we should do in this PR before merging? |
|
@rodgtr1 👍 Do you have permissions to approve? |
Ahh, though I did. Done. |
3 participants
The current Linux Server guide includes instructions for accessing the server and viewing a session recording. For users who are not interested in server access, this can be irrelevant or even a turnoff. Instead of showing SSH-specific features, make the final step about registering resources using the Web UI.