Commit Graph
10 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
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
Ben Arent ce17dec654 Update SSO guides (#7671)
* Cleaning Okta copy.
* Update other connectors.
* Cleanup and URL tweaks.

Signed-off-by: Alexander Klizhentas <klizhentas@gmail.com>
2021-07-31 13:28:53 -07:00
Roman Tkachenko 0b0f631757 Add MongoDB guide, MySQL Cloud SQL guide and other 7.0 docs updates (#7350) 2021-07-12 09:12:21 +03:00
Roman Tkachenko fc713b7216 Application and database access documentation updates (#6932) 2021-05-18 17:03:49 -07:00
Alexey Ivanov 3bf8425876 v7.0 syntax update (#6314)
* Update syntax

# Conflicts:
#	docs/pages/enterprise/sso/ssh-google-workspace.mdx

* Run lint and fix lint errors

* Fix include path
2021-04-06 12:16:28 -07:00
Alexander Klizhentas fbae7ad508 Open Sources Access Controls Docs (#6188) (#6217)
* Open Sources Access Controls Docs (#6188)

Moves RBAC to a separate access controls section,
adds a couple of guides and prepares
the structure for more content.

* Fix href links
2021-03-30 10:04:23 -07:00
Alexey Ivanov 306f74b211 Lint markdown files syntax for master with the new linter (#5881)
* Lint docs files
* Fix includes
* Remove releases-table
2021-03-08 08:39:48 -08:00
Alexey Ivanov fa4d7eb977 Update docs structure (#5849) 2021-03-04 10:07:48 -08:00