Commit Graph
15 Commits
Author SHA1 Message Date
Alex Fornuto 32408a0a81 spelling, typos, and non-example nouns fixed (#18943) 2022-12-01 16:57:10 +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
Zac Bergquist 2dad6039a7 docs: CamelCase GitHub (#13240)
Fixes #10895
2022-06-07 22:00:54 +00:00
Steven Martin b34ba358f9 Synch Teleport preview updates (#10318) 2022-02-14 20:12:27 +00:00
Kevin Nisbet 30effc1f08 docs: update cloud roadmap and faq (#9479)
* docs: update cloud roadmap and faq

* address review feedback

* address review feedback
2021-12-22 16:52:08 +00:00
Alexander Klizhentas cfc4567906 Splits admin guide into setup sections (#8324)
* Updates scaling guide.
* Rewrites CA rotation guide.
* Small tweaks and fixes to other parts.
2021-09-20 10:22:12 -07:00
Russell JonesandAlexander Klizhentas 6bc4f2e395 Update upcoming-releases.mdx (#7584)
Co-authored-by: Alexander Klizhentas <klizhentas@gmail.com>
2021-07-16 13:51:54 -07:00
Andrew Lytvynov cd2036a1a6 docs: delay 6.2 release on upcoming releases page 2021-05-21 16:44:43 +00:00
Roman Tkachenko fc713b7216 Application and database access documentation updates (#6932) 2021-05-18 17:03:49 -07:00
Andrew Lytvynov 569dec6be5 docs: bump 6.2 release date to May 21st (#6652) 2021-04-29 13:59:34 -07:00
Alexander Klizhentas 20c6ea3e54 Adds releases preview (#6533) 2021-04-22 13:15:20 -07:00
Alexander Klizhentas cfd23e9417 Documents dual authz with Mattermost (#6400)
Add Cloud SQL guide
Update preview
2021-04-09 17:45:02 -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
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