Commit Graph
5 Commits
Author SHA1 Message Date
Bence Kiglics 41474a021d Add documentation for Slack Helm chart (#13726)
It includes an updated guide and the reference of the new Helm chart.
2022-09-26 10:11:17 +00:00
Bence Kiglics c522b38383 Add documentation for MatterMost Helm chart (#13728)
Includes an updated guide and the reference of the new Helm chart.
2022-09-08 11:49:30 +00:00
Bence Kiglics 5e476ed17d Add documentation for PagerDuty Helm chart (#13729) 2022-08-31 15:57:20 +00:00
Bence KiglicsandPaul Gottschling 6e246ab5c9 Add documentation for Jira Helm chart (#13730)
* Add documentation for Jira Helm chart

It includes an updated guide and the reference of the new Helm chart.

* Fixed some minor mistakes in the guides

* Reorganized Helm related examples

* Fixed a few minor mistakes

* Alphabetized jira.* settings

* Renamed Cloud to Executable in Testing

* Extended YAML config example with explanation

* Edit Jira Access Request plugin Helm chart docs

- Edit the configuration instructions so we don't instruct Helm users to
  use the `configure` subcommand. Also use the `Tabs` component's
  dropdown functionality so we can include both self-hosted and Teleport
  Cloud instructions for Helm and VM users.

- Minor style tweaks.

* Add Helm Chart example to Installation section

* Removed confusing (and broken) link
git push

* Fixed wrong default value

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-08-26 12:23:07 +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