-
Notifications
You must be signed in to change notification settings - Fork 25.4k
Reconciles the Roles page #133831
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
Reconciles the Roles page #133831
Conversation
The Roles page is duplicated and exists in both the Deploy and manage and the Reference sections. The content is starting to drift, so I'm editing the page in the Reference section to reconcile the information. Refers to [elastic#2738](elastic/docs-content#2738)
🔍 Preview links for changed docs |
Pinging @elastic/core-docs (Team:Docs) |
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.
shocking that there are so few deprecated roles - works for me.
couple of little comments then good to go
This section provides detailed **reference information** for Elasticsearch privileges. | ||
|
||
Refer to [User roles](docs-content://deploy-manage/users-roles/cluster-or-deployment-auth/user-roles.md) in the **Deploy and manage** section for overview, getting started and conceptual information. | ||
::: | ||
If you're using a stack-versioned deployment such as a self-managed cluster, {{ech}}, {{eck}}, or {{ece}}, then refer to [User roles](docs-content://deploy-manage/users-roles/cluster-or-deployment-auth/user-roles.md) for more information on how role-based access control works. |
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.
no need to clarify "if you're using stack" here because the page is labeled as stack and serverless has different built-in roles
if you really felt fancy you could add a note to that effect (details here)
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.
Thing is I wanted to include another link to info about roles in Serverless (similar to what we did in the privileges page), and then I forgot to get back to that paragraph and add the link.
Do you think it works now, @shainaraskas ?
I've isolated it in a tip because it only slightly relates to the content on the page, but could be very useful to someone who landed on that page accidentally and was looking for directions on how to get to the Deploy and manage 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.
I think that the way that this is organized together in a single tip is confusing. one of the paragraphs is explaining more about applying the roles that you're reading about now, and the other is redirecting you to a different location if your context is different.
I've provided a couple of edits that I think addresses the confusion.
In general, I think redirections make sense in a note, but information that is key to applying or understanding a concept should not.
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.
Thank you for expanding on that, it makes a lot of sense. I think it's good guidance and we should have it documented somewhere, because the way we link to other docs is not consistent and it's difficult to infer what the recommended patterns are.
ℹ️ Important: Docs version tagging👋 Thanks for updating the docs! Just a friendly reminder that our docs are now cumulative. This means all 9.x versions are documented on the same page and published off of the main branch, instead of creating separate pages for each minor version. We use applies_to tags to mark version-specific features and changes. Expand for a quick overviewWhen to use applies_to tags:✅ At the page level to indicate which products/deployments the content applies to (mandatory) What NOT to do:❌ Don't remove or replace information that applies to an older version 🤔 Need help?
|
This section provides detailed **reference information** for Elasticsearch privileges. | ||
|
||
Refer to [User roles](docs-content://deploy-manage/users-roles/cluster-or-deployment-auth/user-roles.md) in the **Deploy and manage** section for overview, getting started and conceptual information. | ||
::: | ||
If you're using a stack-versioned deployment such as a self-managed cluster, {{ech}}, {{eck}}, or {{ece}}, then refer to [User roles](docs-content://deploy-manage/users-roles/cluster-or-deployment-auth/user-roles.md) for more information on how role-based access control works. |
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 think that the way that this is organized together in a single tip is confusing. one of the paragraphs is explaining more about applying the roles that you're reading about now, and the other is redirecting you to a different location if your context is different.
I've provided a couple of edits that I think addresses the confusion.
In general, I think redirections make sense in a note, but information that is key to applying or understanding a concept should not.
The Roles page is duplicated and exists in both the Deploy and manage and the Reference sections. The content is starting to drift, so I'm editing the page in the Reference section to reconcile the information.
Refers to #2738
Details:
kibana_user
role is deprecated, so I added theapplies_to
tag. I can't find info on when it was deprecated only that it is deprecated.kibana_dashboard_only_user
is deprecated, so I added theapplies_to
tag. I can't find info on when it is deprecated (strange I can find no mention of this role in the Kibana repo).reporting_user
roles is marked as deprecated here but wasn't marked as such on the Roles page in the Reference section, so I've updated that.