Commit Graph
107 Commits
Author SHA1 Message Date
Logan Davis 6cbc9e1142 Update helm chart snapshots and tests for amazon ECR Public (#15355) 2022-08-23 16:03:40 +00:00
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
Alexander KlizhentasandBen Arent e49e894efe Sasha/fwd user (#7996)
* Video Banner (#7914)

* Drain off admin guide into setup sections. (#7960)

* Expand daemon section and graceful restarts guide
* Move API section to top
* Move references to setup

Co-authored-by: Ben Arent <ben@goteleport.com>
2021-08-19 15:00:26 -07:00
inertial-frame 9fbe282052 [v7.0] docs: port of edit pass 2/9 (#7173)
* docs: port 6961

* docs: comment out line

* docs: correct OSS

* docs: correction

* docs: bump example from 24h to 2190h

* docs: update notes
2021-06-15 20:14:00 -05:00
inertial-frame e519af958e [v7.0] docs: port of edit pass 3/9 (#7187)
* docs: port of 6968

* docs: correct link

* docs: header
2021-06-15 19:32:04 -05:00
inertial-frame c5f3f56719 docs: port api changes (#7031) 2021-06-02 15:40:43 -05:00
Brian Joerger d830ed6db7 Refactor api package and docs to use pkg.go.dev effectively. (#6388) 2021-04-20 16:44:17 -07:00