Commit Graph
5 Commits
Author SHA1 Message Date
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
Steven Martin 4f603a8c27 Change bash examples to code. Fixes copy/paste and more consistent (#11910) 2022-04-14 14:54:28 +00:00
Joel ddee244cde Add documentation for moderated sessions (#9425) 2022-02-11 14:12:00 +01:00
Alexander KlizhentasandRoman Tkachenko 3610d05956 Cleanup docs on users and roles (#8098) (#8099)
* Cleanup docs on users and roles

- Updates roles to use v4
- Moves users to a separate guide
- Creates up to date reference for users and roles resources

* Update docs/pages/setup/reference/resources.mdx

Co-authored-by: Roman Tkachenko <roman@gravitational.com>

Co-authored-by: Roman Tkachenko <roman@gravitational.com>

Co-authored-by: Roman Tkachenko <roman@gravitational.com>
2021-08-30 19:53:44 -07: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