Skip to content

Conversation

yetanothertw
Copy link
Contributor

@yetanothertw yetanothertw commented Aug 29, 2025

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:

  • The kibana_user role is deprecated, so I added the applies_to tag. I can't find info on when it was deprecated only that it is deprecated.
  • The kibana_dashboard_only_user is deprecated, so I added the applies_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).
  • The 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.

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)
@yetanothertw yetanothertw self-assigned this Aug 29, 2025
@yetanothertw yetanothertw added >docs General docs changes Team:Docs Meta label for docs team documentation labels Aug 29, 2025
Copy link
Contributor

github-actions bot commented Aug 29, 2025

🔍 Preview links for changed docs

@yetanothertw yetanothertw marked this pull request as ready for review August 29, 2025 15:58
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/core-docs (Team:Docs)

Copy link
Contributor

@shainaraskas shainaraskas left a 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.
Copy link
Contributor

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)

Copy link
Contributor Author

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.

Copy link
Contributor

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.

Copy link
Contributor Author

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.

Copy link
Contributor

github-actions bot commented Sep 2, 2025

ℹ️ 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 overview

When to use applies_to tags:

✅ At the page level to indicate which products/deployments the content applies to (mandatory)
✅ When features change state (e.g. preview, ga) in a specific version
✅ When availability differs across deployments and environments

What NOT to do:

❌ Don't remove or replace information that applies to an older version
❌ Don't add new information that applies to a specific version without an applies_to tag
❌ Don't forget that applies_to tags can be used at the page, section, and inline level

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

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.

@yetanothertw yetanothertw merged commit 16fb8b8 into elastic:main Sep 3, 2025
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes documentation Team:Docs Meta label for docs team v9.2.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants