Open ptgott opened 1 year 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.
Applies To
All how-to guides:
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