Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
docs: rbac getting started guide #48029
base: master
Are you sure you want to change the base?
docs: rbac getting started guide #48029
Changes from 3 commits
68326ee
80c3339
02d100a
69bd091
27a431a
7108e67
6c868e5
6fce0bf
e88cc55
31270a2
5826419
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would it make sense to focus this guide on roles and label matching and, rather than spell out the kinds of users here, link to the User Types reference in a "Further reading" or "Next steps" section?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mmcallister What do you think about the comment above? In general, I think this guide should be a lot more focused. I would start by identifying the objective of the guide in the intro paragraph (making it as narrow as possible), then editing the structure of the guide based on that objective. How does that sound?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a way to merge this with our table of preset roles? Otherwise, it's not clear to me what we're referring to when we talk about these particular roles
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We use sentence case in headings: https://github.com/gravitational/docs/blob/main/docs-contributors/style-guide.md#headings
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Otherwise, this is difficult to read as regular text
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
tctl
reads YAML, but you can also manage roles with Terraform, the Teleport Kubernetes operator, and other API clients.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would make the guide more focused as a how-to guide or a conceptual guide, rather than bringing together features of both of them (see the style guide).
Check failure on line 86 in docs/pages/admin-guides/access-controls/getting-started.mdx
GitHub Actions / Lint docs prose style