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

Edit the Resource Request guide #52393

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ptgott
Copy link
Contributor

@ptgott ptgott commented 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.

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.
Copy link

github-actions bot commented Feb 21, 2025

Amplify deployment status

Branch Commit Job ID Status Preview Updated (UTC)
paul.gottschling/33417-requests HEAD 1 ✅SUCCEED paul-gottschling-33417-requests 2025-02-21 19:19:57

@@ -1126,6 +1127,139 @@ $ tsh ssh node1.leaf1
$ ssh node1.leaf1
```

## Request access to resources
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This feels more like it belongs in an "access requests" section of the docs, not in a tsh section of the docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Find a better home for the reference info in the Resource Requests guide
2 participants