Commit Graph
7 Commits
Author SHA1 Message Date
Paul Gottschling 969ad63063 Update the Team Getting Started guide (#37340)
- Update instructions and images to match the v15 UI.
- Minor readability improvements.
- Replace `mytenant` with `example` in example URLs since we're phasing
  out the "tenant" language.
2024-01-26 17:52:03 +00:00
Paul Gottschling 732b9bbf58 Remove unused images from the docs (#32164)
Used the following command to find unused images. This lists all image
files in the docs and, for each image, searches all docs pages for
references to the image file (which include the `/img` path segment but
usually not `docs`). If there are no matches, it prints the image file
name:

```bash
$ find docs/img -name "*.png" | sed -E "s|docs/(.*)|\1|" | xargs -I{} bash -c '
grep -qR "{}" docs/pages; if [ $? -ne 0 ]; then echo {}; fi'
```

Also fixes a minor linter error that did not come up in earlier commits.
2023-09-20 18:12:08 +00:00
Paul Gottschling 1296b06955 Add Teleport Team docs (#26523)
* Add documentation for Teleport Team

- Remove the Teleport Enterprise Cloud Getting Started guide, since this
  assumes that you have signed up for an Enterprise Cloud trial.
  Instead, users will sign up for a Team trial to add their first
  resource and follow a new guide to using Teleport Team.
- Move references to Teleport Team first in lists of Teleport editions,
  since this is the intended first step for self-service users.

* Update the Teleport Team guide

- Update screenshots
- Move Docker instructions to a Details box and make Docker optional,
  with the idea that Linux and macOS users could join their workstations
  to their Teleport cluster.

* Require a Docker container again

In this test environment, there was no support for ARM on macOS.
Requiring a container ensures consistency between environments.

* Add a diagram

* Fix links

* Linter fixes

* Respond to alexfornuto feedback
2023-05-19 20:15:40 +00:00
Paul Gottschling 2a7be957f4 Simplify the Getting Started experience (#25415)
This change makes the experience of getting started with Teleport more
opinionated and more precisely molded around our intended audience. The
assumption is that people who want to go through our getting started
experience are skilled technologists who:

- Are curious about how Teleport works and want to tinker with a toy
  cluster
- Need to set up a production cluster in order to protect their
  infrastructure, in which case a toy cluster is less important than a
  way to get started with the real thing

Promote the "Linux Server" guide
--------------------------------

Make the "Linux Server" guide the definitive introduction to OSS
Teleport by removing other "Try out Teleport" guides and moving this one
to the "Home" section. We want to remove the need for users to decide
which getting started guide to try, and this guide is the only one that
lets users spin up a fully fledged demo cluster besides the Digital
Ocean guide.

To let users know about the DigitalOcean 1-Click droplet, this change
links to our DigitalOcean 1-Click app from within the Linux Server
guide. It also advises users who don't meet the Linux Server guide
prerequisites to sign up for a Teleport Enterprise Cloud free trial.

This change also removes the Docker guide and redirects Docker-related
traffic to the Installation page, since the Docker guide is more of a
Getting Started guide than an integration guide, and our Installation
page already includes Docker setup information.

Edit the Linux Server getting started guide
-------------------------------------------

- Remove Application Service instructions, since it can turn off users
  who, for example, don't use Python or don't want to run the
  Application Service (plus we already mention it at the end of the
  guide for users who do want to run this service).

- Update installation instructions to use our one-liner.

- Make this guide more explicitly focused on the Open Source edition,
  removing Enterprise instructions. Users who want to tinker with
  Teleport will not be interested in the Enterprise edition.

- Add session recording instructions. Most of the content of the Linux
  Server guide has to do with setting up Teleport, rather than seeing
  Teleport features, so I wanted to adjust this balance a bit.

- Remove the permission warning. It takes up around 1/4 of the screen
  height when viewing the page, and we expect our intended audience to
  know this information already.

Change the Enterprise information architecture
----------------------------------------------

- Remove the Enterprise "Getting Started" guide: This guide shows you
  how to deploy a demo Teleport Enterprise cluster, which is sort of a
  contradiction in terms. Enterprise users expect a production-grade
  cluster, which is not what you get in this guide.

- In the Enterprise Introduction page, include instructions to read the
  Deployment Guides, which show how to set up a mature HA deployment,
  plus a recommendation to use Teleport Enterprise Cloud unless you need
  the Enterprise-specific features explained in this guide.
2023-05-02 21:18:28 +00:00
Paul Gottschling c0db988b85 Improve the Teleport Cloud Getting Started guide (#20837)
* Improve the Teleport Cloud Getting Started guide

While following the Teleport Enterprise Cloud Getting Started guide to
test v12, I made the following changes to the guide:

- Change the title of the guide--and language throughout our Cloud
  docs--to use "Teleport Enterprise Cloud" instead of "Teleport Cloud".
  This reflects the usage in our Core Concepts page.

- Add a brief architectural explanation to the guide in case users
  arrive here from a search engine.

- Restructure the guide to include a step to start a local Docker
  container. This way, we can (a) ensure that all steps are consistent
  for all users; and (b) let the user get started quickly without "real"
  infra.

- Include instructions to paste a script generated via Teleport Discover
  into the container shell.

- Update screenshots.

* Respond to alexfornuto feedback

* Minor wording change

Responding to PR feedback
2023-02-03 23:22:29 +00:00
Steven Martin c2fafaf6e8 Updates to cloud getting started (#19657)
* Expand cloud getting started to include replaying sessions and all desktop installations
2023-01-15 17:38:26 +00:00
Steven Martin 1b1f05c14e [v7] cloud getting started updates (#6481)
getting started update
* Update faq.mdx
2021-04-15 18:36:02 -07:00