Files
teleport/docs
Jakub NyckowskiandPaul Gottschling ef1d275e56 Add "Access Graph" docs (#35154)
* Add "Access Graph" docs

Access Graph docs have been added under slug /access-graph/. This document provides details about the Teleport Access Graph. Currently, this feature is only available to Teleport Cloud Team users and is in its preview stage.

Signed-off-by: Jakub Nyckowski <jakub.nyckowski@goteleport.com>

* Add images

Signed-off-by: Jakub Nyckowski <jakub.nyckowski@goteleport.com>

* Fix typo

Signed-off-by: Jakub Nyckowski <jakub.nyckowski@goteleport.com>

* Updated docs for Teleport Access Graph feature

Expanded documentation for Teleport Access Graph feature to include more detailed information about the usage and functionality. Additional visual aids were added to provide a clearer understanding of the concept. Also, specific instructions were included to spotlight the versatility of the feature for advanced user control and management.

Signed-off-by: Jakub Nyckowski <nyckowski.jakub@gmail.com>

* Add detailed description of Graph paths in Teleport Access Graph doc

Included detailed explanations about the allow paths and deny paths in the Teleport Access Graph documentation. This change provides users with clearer insights about accessing and managing resources. Also added imagery to visually reinforce the concepts of the Access Graph.

Signed-off-by: Jakub Nyckowski <nyckowski.jakub@gmail.com>

* Normalize the size images

Signed-off-by: Jakub Nyckowski <nyckowski.jakub@gmail.com>

* Update Access Graph documentation for clarity

This commit refines the Access Graph section of the Teleport documentation. It provides a clearer sequence of paths, detailing how they proceed from Users to Resources. Also, the description of how User Groups are created, either from Roles or accepted access requests, has been enhanced for more clarity. This aims to improve user understanding of Teleport functionalities.

Signed-off-by: Jakub Nyckowski <nyckowski.jakub@gmail.com>

* Address review comments

Signed-off-by: Jakub Nyckowski <nyckowski.jakub@gmail.com>

* Update user import details in access-graph.mdx

This update adds important information about user importation in the Teleport documentation. It specifies that local users are imported as soon as they are created, while external users are only imported when they log in for the first time.

Signed-off-by: Jakub Nyckowski <nyckowski.jakub@gmail.com>

* Refine explanation and structure of access-graph.mdx

The Teleport Access Graph documentation is updated to improve clarity and accuracy. It now explains more clearly how it visualizes access to infrastructure, expands the main components from five to eight, and refines the explanation on User Groups. Additionally, the Access Graph section is relocated within the documentation structure for better organization.

Signed-off-by: Jakub Nyckowski <nyckowski.jakub@gmail.com>

* Refine explanation and structure of access-graph.mdx

The Teleport Access Graph documentation is updated to improve clarity and accuracy. It now explains more clearly how it visualizes access to infrastructure, expands the main components from five to eight, and refines the explanation on User Groups. Additionally, the Access Graph section is relocated within the documentation structure for better organization.

Signed-off-by: Jakub Nyckowski <nyckowski.jakub@gmail.com>

* Refine explanation and structure of access-graph.mdx

The Teleport Access Graph documentation is updated to improve clarity and accuracy. It now explains more clearly how it visualizes access to infrastructure, expands the main components from five to eight, and refines the explanation on User Groups. Additionally, the Access Graph section is relocated within the documentation structure for better organization.

Signed-off-by: Jakub Nyckowski <nyckowski.jakub@gmail.com>

* Update docs/pages/access-graph.mdx

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

* Fix linter errors

Signed-off-by: Jakub Nyckowski <nyckowski.jakub@gmail.com>

---------

Signed-off-by: Jakub Nyckowski <jakub.nyckowski@goteleport.com>
Signed-off-by: Jakub Nyckowski <nyckowski.jakub@gmail.com>
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-12-07 16:37:09 +00:00
..
2023-12-07 16:37:09 +00:00
2023-12-07 16:37:09 +00:00
2023-12-07 16:37:09 +00:00

Teleport Docs

Teleport docs are built using Next.js. Please see the README in the docs repo for details on how to make and test changes to Teleport docs.

Run make -C build.assets test-docs from the root directory of this repo.