gravitational / teleport

The easiest, and most secure way to access and protect all of your infrastructure.
https://goteleport.com
GNU Affero General Public License v3.0
17.47k stars 1.74k forks source link

In how-to guides, list the Teleport permissions required to complete the guide #20865

Open ptgott opened 1 year ago

ptgott commented 1 year ago

Applies To

All how-to guides:

$ grep -RlE "^## Step [0-9]+/[0-9]+" docs/pages

Details

Our how-to guides often involve getting, creating, or modifying configuration resources, but usually don't indicate which Teleport permissions a user needs to perform those actions and follow the instructions. Let's ensure that all of our how-to guides list these permissions at the top of the guide.

Related Issues

ptgott commented 8 months ago

Rather than edit all how-to guides in a single, large project, we could add a Vale linter rule (see this GitHub Actions job) that requires all pages with a Prerequisites section and steps (i.e., all how-to guides) to include an H2 called "Required permissions" (or whatever component we decide to go with to list the required permissions). That way, any PR editing a how-to guide will need to include the required permissions to pass CI.