Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Find a better home for the reference info in the Resource Requests guide #33417

Open
ptgott opened this issue Oct 12, 2023 · 0 comments · May be fixed by #52393
Open

Find a better home for the reference info in the Resource Requests guide #33417

ptgott opened this issue Oct 12, 2023 · 0 comments · May be fixed by #52393
Labels
documentation rbac Issues related to Role Based Access Control

Comments

@ptgott
Copy link
Contributor

ptgott commented Oct 12, 2023

Applies To

docs/pages/access_controls/access-requests/resource-requests.mdx

Details

At the time I created this issue, the Resource Requests guide is 668 lines long, and over half of these are in the "Next Steps" section. We should move this content out of the Resource Requests how-to guide to make it easier for users to discover this content—and for us to expand this content as we develop Teleport's Access Request capabilities.

How will we know this is resolved?

The information in the "Next Steps" section of the Resource Requests guide (as of the time this issue was created) is in a more appropriate place.

Related Issues

#33414 adds an Access Request configuration guide. We can find a way to work this information into that guide.

@ptgott ptgott added the rbac Issues related to Role Based Access Control label Apr 10, 2024
ptgott added a commit that referenced this issue Feb 21, 2025
Closes #33417

Focus the guide more on its stated topic by moving tangentially related
reference information at the end of the guide to more appropriate pages.

- Replace the `search_as_roles` section with a link. Much of the "Next
  steps" section is a long list of examples of Teleport roles that an
  admin could assign to `search_as_roles`. This is unnecessary, since a
  user familiar with a Teleport role won't need this information to
  understand `search_as_roles`. It is not the job of the Resource Requests
  guide to teach users about Teleport roles.
- Condense the "Next steps" guidance. There are "Next steps" sections.
  Make them one. Also turn the section re: Access Request plugins into a
  bullet.
- Move instructions for searching for and requesting Kubernetes
  resources into the tsh guide. These instructions are end users, so
  move them to the appropriate guide to make them more discoverable.
ptgott added a commit that referenced this issue Feb 21, 2025
Closes #33417

Focus the guide more on its stated topic by moving tangentially related
reference information at the end of the guide to more appropriate pages.

- Replace the `search_as_roles` section with a link. Much of the "Next
  steps" section is a long list of examples of Teleport roles that an
  admin could assign to `search_as_roles`. This is unnecessary, since a
  user familiar with a Teleport role won't need this information to
  understand `search_as_roles`. It is not the job of the Resource Requests
  guide to teach users about Teleport roles.
- Condense the "Next steps" guidance. There are "Next steps" sections.
  Make them one. Also turn the section re: Access Request plugins into a
  bullet.
- Move instructions for searching for and requesting Kubernetes
  resources into the tsh guide. These instructions are end users, so
  move them to the appropriate guide to make them more discoverable.
@ptgott ptgott linked a pull request Feb 21, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation rbac Issues related to Role Based Access Control
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant