Commit Graph
3 Commits
Author SHA1 Message Date
MichaelandPaul Gottschling 6c58a9ecd9 [docs] Add documentation for static and dynamic ui_config (#22736)
* [docs] Add documentation for static and dynamic ui_config

* Fix indentation

* Add newline

* Apply suggestions from code review

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-03-07 23:31:58 +00:00
Michael Wilsonandalexfornuto 48daeff5bd SAML identity provider docs. (#22414)
* SAML identity provider docs.

SAML IdP documentation has been added.

* formatting

* spelling

* Zac's and Roman's feedback.

* Valid config.json.

* Linting updates.

* usr Var component

Adding as a unique commit in case it's not desired

* align output with object name

* Roman's feedback, add in a section for disabling the IdP.

* copy edits

* SAML Grafana guide (#22545)

* init Grafana SAML guide

* respond to review feedback

* Correct entity provider to identity provider.

* Note that HSM is not currently supported.

* Fix link.

---------

Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
2023-03-04 00:29:52 +00:00
Paul GottschlingandAlex Fornuto da0e53ecdb Reorganize the config reference (#21594)
* Reorganize the config reference

Closes #11253

This change breaks up the config reference by moving each Teleport
service's configuration settings into a separate YAML snippet, and
organizing each YAML snippet into a `TabItem` within a `Tabs` with
`dropdownView` enabled. When Teleport Enterprise Cloud doesn't support a
service, this change adds a `Notice` with a message about Teleport
Enterprise Cloud in the relevant `TabItem`.

I thought this approach would be cleaner than alternatives:

- **Including an H2 for each service:** With this approach, the
  configuration reference would be even longer than it is now. With the
  approach I'm proposing, readers would navigate to "Reference
  configurations", then choose a service from a dropdown menu: much less
  scrolling for slightly more clicking.

- **Including another set of `TabItem`s for Teleport editions:** I
  thought about adding a `Tabs` with a dropdown option for each Teleport
  edition and a horizontal `TabItem` for each service, but this would
  require horizontal scrolling and doesn't scale very well.

- **Including horizontal tabs for each Teleport edition**, with an inner
  dropdown menu for each Teleport service: There is currently no way to
  do this without multiple `Tabs` components, which gets messy quickly.

**Note** that this change does not attempt to copy-edit comments/example
values within the configuration snippets. The scope of this change is
limited only to reorganization.

* Respond to PR feedback

* Update docs/pages/includes/config-reference/instance-wide.yaml

Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>

* Respond to PR feedback

Use headings instead of `TabItem`s to split up sections of the config
reference.

---------

Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>
2023-02-24 22:12:38 +00:00