Files
teleport/docs/pages/getting-started.mdx
T
Paul Gottschling 91c89b6126 Organize docs guide sections chronologically (#15357)
* Organize docs guide sections chronologically

This change aims to make docs navigation easier by organizing some docs
sections according to the sequence of steps a user would take to set up
Teleport.

The current docs organization uses a variety of categories and schemes
to organize the docs. For example, there is a "Home" section that
includes the Changelog, Installation page, and Getting Started guides; a
"Setup" section that includes references and admin guides; and
edition-specific sections (Enterprise, Cloud). For a user who is setting
up Teleport--or who has already done some setup work and wants more
advanced instructions--it's difficult to know where in the docs to find
the right information.

This change organizes our how-to guides into the following categories
that describe the process of setting up Teleport:

- Try out Teleport
- Deploy a Cluster (including choosing an edition)
- Configure Access (including SSO, RBAC, and Access Requests)
- Manage your Cluster (admin guides, operations, etc.)
- Use Teleport (this section already exists)

I moved the Reference section after this chronology, since users can
access the reference guides anywhere in the setup process.

As part of the change, I have also moved the content from the
"Enterprise" and "Cloud" sections into "Deploy a Cluster", since this
content has to do with how to deploy a specific edition of Teleport.

Note that this change does _not_ attempt to reorganize our
protocol-specific sections. While adding resources is part of the
Teleport setup process, we have a lot of content in our
protocol-specific sections, and moving it all into a single section
related to adding resources to a cluster would (a) exceed the maximum
depth for subsections in the nav bar and (b) cause more confusion than
it alleviates.

* Respond to PR feedback

- Create a "Compliance Frameworks" section of "Configure Access" with
  the FedRAMP and SOC 2 guides
- Rename "Use Teleport" to "Connect your Client"
- Move the database GUI client guide into "Connect your Client"

* Add redirects

* Fix linter issues
2022-08-22 19:45:32 +00:00

47 lines
2.0 KiB
Plaintext

---
title: Getting started
description: Getting started with Teleport - identity-aware access plane for SSH, HTTPS, Kubernetes, and Databases.
layout: tocless-doc
---
Follow these guides to get started using Teleport.
## Try a lab on your local machine
- [Browser Lab](https://goteleport.com/labs): Try Teleport using our guided interactive labs.
- [Docker Compose Lab](./try-out-teleport/docker-compose.mdx): Try Teleport locally using Docker Compose.
- [Kubernetes Lab](./try-out-teleport/local-kubernetes.mdx): See how Teleport runs on Kubernetes with this local lab.
## Try Teleport in your infrastructure
Not sure which edition of Teleport is right for you? View our [comparison chart](./faq.mdx#how-is-open-source-different-from-enterprise).
<Tabs>
<TabItem scope="oss" label="Open Source Teleport">
Host your own Teleport deployment.
- [Linux Server](./deploy-a-cluster/open-source.mdx): Learn how to host your own open source Teleport deployment on a standalone Linux server.
- [Kubernetes](./deploy-a-cluster/helm-deployments/kubernetes-cluster.mdx): Learn how to host your own open source Teleport deployment on Kubernetes.
</TabItem>
<TabItem scope="cloud" label="Teleport Cloud">
Teleport Cloud is a deployment of the Auth Service and Proxy Service,
managed by a dedicated team at Teleport.
- [Learn More](./deploy-a-cluster/teleport-cloud/getting-started.mdx): Learn how to start using Teleport Cloud.
- [Start your Free Trial](https://goteleport.com/signup): Try Teleport hosted by us in the cloud for free.
</TabItem>
<TabItem scope="enterprise" label="Teleport Enterprise">
Get started with a self-hosted Teleport Enterprise deployment, which gives you
more advanced features and full customization.
- [Getting Started](./deploy-a-cluster/teleport-enterprise/getting-started.mdx): Learn how to deploy Teleport Enterprise.
- [Kubernetes](./deploy-a-cluster/helm-deployments/kubernetes-cluster.mdx): Learn how to host your Teleport Enterprise deployment on Kubernetes.
</TabItem>
</Tabs>