Skip to content

Turn the Linux Server guide into the docs landing page#26407

Closed
ptgott wants to merge 4 commits intomasterfrom
paul.gottschling/2023-05-16-get-started-reorg
Closed

Turn the Linux Server guide into the docs landing page#26407
ptgott wants to merge 4 commits intomasterfrom
paul.gottschling/2023-05-16-get-started-reorg

Conversation

@ptgott
Copy link
Copy Markdown
Contributor

@ptgott ptgott commented May 16, 2023

This is a WIP draft that responds to some feedback by @rodgtr1 and @kontsevoy. It is an extension of #26309 that makes the Linux Server guide the landing page of the docs.

We still need to:

  • Flesh out the introduction of the Linux Server guide. Now that it's the docs landing page, we will need a smoother introduction than, "This tutorial will show you how to install and run a demo Teleport cluster on a Linux host using Teleport Community Edition."
  • Add a diagram. This will be a user's first visual introduction to the architecture of Teleport, so we need to be careful about this.

ptgott added 4 commits May 16, 2023 17:33
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.
This way, users get an even shorter path to getting started with
Teleport than they had before. The former index page becomes a
Documentation Overview page, since its main function is to describe the
different sections of the documentation.
@ptgott
Copy link
Copy Markdown
Contributor Author

ptgott commented Jun 30, 2023

Closing in favor of #27703

@ptgott ptgott closed this Jun 30, 2023
@ptgott ptgott deleted the paul.gottschling/2023-05-16-get-started-reorg branch October 4, 2024 13:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant