-
Notifications
You must be signed in to change notification settings - Fork 1.9k
docs: revamp Getting Started guide #57931
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
base: master
Are you sure you want to change the base?
Conversation
Amplify deployment status
|
182e126
to
a9e1c78
Compare
a9e1c78
to
d525d06
Compare
d525d06
to
70a4a8d
Compare
70a4a8d
to
9a90c12
Compare
9a90c12
to
21f6c2d
Compare
66c69fd
to
9d29522
Compare
9d29522
to
a184399
Compare
a184399
to
65fd8ef
Compare
65fd8ef
to
bbe38ac
Compare
bbe38ac
to
6e69092
Compare
6e69092
to
1e49e47
Compare
1005388
to
b4c5a24
Compare
b4c5a24
to
ea47b32
Compare
f8e97d0
to
07208fc
Compare
* Clarify self-hosted Enterprise starter guidance Closes #8547 Make it more explicit in the self-hosted Teleport Enterprise index page that self-hosted deployents start with outreach to the Teleport team, and that the HA guide and multi-region blueprint are outlines to help a team plan a deployment that a customer designs in conversation with the Teleport team. Otherwise, the implication is that the guides listed on the self-hosted Teleport Enterprise index page are sufficient for deploying a self-hosted cluster. There has been a longstanding request for Oracle Cloud guidance, and rather than expect these users to be self sufficient, explain that the recommended approach is to reach out to Teleport and model a deployment based on our architectural outlines. Some new text in the self-hosted Enterprise index page is based on #57931. * Edit the self-hosted Teleport Enterprise intro Respond to internal feedback by **pschisa**. The multi-region blueprint is recommended only for a select group of organizations with specific needs. For the general introduction, link only to the single-region HA guide.
👍 Let's plan to review the pageviews for the Getting Started series in a month or so and see if it would benefit from SEO improvements. |
* Clarify self-hosted Enterprise starter guidance Closes #8547 Make it more explicit in the self-hosted Teleport Enterprise index page that self-hosted deployents start with outreach to the Teleport team, and that the HA guide and multi-region blueprint are outlines to help a team plan a deployment that a customer designs in conversation with the Teleport team. Otherwise, the implication is that the guides listed on the self-hosted Teleport Enterprise index page are sufficient for deploying a self-hosted cluster. There has been a longstanding request for Oracle Cloud guidance, and rather than expect these users to be self sufficient, explain that the recommended approach is to reach out to Teleport and model a deployment based on our architectural outlines. Some new text in the self-hosted Enterprise index page is based on #57931. * Edit the self-hosted Teleport Enterprise intro Respond to internal feedback by **pschisa**. The multi-region blueprint is recommended only for a select group of organizations with specific needs. For the general introduction, link only to the single-region HA guide.
* Clarify self-hosted Enterprise starter guidance Closes #8547 Make it more explicit in the self-hosted Teleport Enterprise index page that self-hosted deployents start with outreach to the Teleport team, and that the HA guide and multi-region blueprint are outlines to help a team plan a deployment that a customer designs in conversation with the Teleport team. Otherwise, the implication is that the guides listed on the self-hosted Teleport Enterprise index page are sufficient for deploying a self-hosted cluster. There has been a longstanding request for Oracle Cloud guidance, and rather than expect these users to be self sufficient, explain that the recommended approach is to reach out to Teleport and model a deployment based on our architectural outlines. Some new text in the self-hosted Enterprise index page is based on #57931. * Edit the self-hosted Teleport Enterprise intro Respond to internal feedback by **pschisa**. The multi-region blueprint is recommended only for a select group of organizations with specific needs. For the general introduction, link only to the single-region HA guide.
07208fc
to
6c0f68c
Compare
6c0f68c
to
e051581
Compare
e051581
to
f1c7bc2
Compare
f1c7bc2
to
51164c1
Compare
51164c1
to
33835cf
Compare
33835cf
to
f992692
Compare
f992692
to
98b267d
Compare
98b267d
to
a5648cd
Compare
|
||
There are several editions of Teleport that differ in their feature sets, deployment options, and support. | ||
|
||
Before choosing one, ask yourself: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We don't have to block on this, but I still think we can simplify the UX here. Currently, the user needs to:
- Read a bullet
- Figure out that they need to read the information boxes
- Click an information box that corresponds to a bullet
Would it make sense to include the link and description for each edition within the same component so the reader doesn't need to connect so many dots? We could remove the edition boxes and add a short (< 1 sentence) description of each edition to the bullets that precede them, along with a link to each edition page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We could get rid of the bullet points entirely and just have the three edition boxes maybe?
docs/pages/get-started/connect.mdx
Outdated
|
||
You'll need one of the following: | ||
|
||
- An Ubuntu Linux server that you can SSH into (physical server, VM or cloud instance like EC2, or homelab server) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right now, it seems like the Prerequisites section includes requirements for the whole guide, and that the guide is for connecting infrastructure in general. In other words, it seems like the user needs an Ubuntu Linux server and Docker to connect infrastructure in general.
I would make it clearer that there's a demo/getting started workflow that the user can follow as a quick example.
Also, for a new user, there's only guidance for enrolling this Ubuntu server. We should add some more explicit mention of the fact that there are other resources a user can add through the Web UI.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great feedback, I've updated the page based on it.
a5648cd
to
0fa3f4f
Compare
Revamps the Getting Started experience into a concise, four-step guide: 1. Deploy a Teleport cluster 2. Connect infrastructure 3. Set up access controls 4. Configure audit logging This guide is designed as a multi-page, flowing overview that links to more in-depth documentation (if needed), rather than a long one-page tutorial. Replaces: - Existing single-page Getting Started guide (Teleport Enterprise Cloud) - Linux Demo guide (Teleport Community Edition) Links in other pages have been updated to point to these new locations and sidebar has been updated as well.
0fa3f4f
to
d1dcdd9
Compare
Closes #55490
Revamps the Getting Started experience into a concise, four-step guide:
This guide is designed as a multi-page, flowing overview that links to more in-depth documentation (if needed), rather than a long one-page tutorial.
Replaces:
Links in other pages have been updated to point to these new locations and sidebar has been updated as well.