Skip to content

Conversation

yetanothertw
Copy link
Contributor

@yetanothertw yetanothertw commented Aug 26, 2025

To remove duplication and ensure that information stays accurate, the Elasticsearch privileges page won't include detailed information about each privilege and their descriptions, and instead will refer users to Elasticsearch privileges in the Reference section.

Fixes #2218

@yetanothertw yetanothertw added the documentation Improvements or additions to documentation label Aug 26, 2025
@yetanothertw yetanothertw self-assigned this Aug 26, 2025
@yetanothertw
Copy link
Contributor Author

@shainaraskas -- what are your thoughts on all the pages within the User roles section (and other pages within the Deploy and manage section of the docs-content repo) that link to this page? Should they be updated to point to the page in the Reference section or is it okay to leave them as is?

@shainaraskas
Copy link
Collaborator

@yetanothertw I think the xlinks definitely need to be updated. here's what I'd do:

  • kill this page and redirect
  • add an xlink to the nav to the new page because this page is so important (see Add crosslinks to toc: in docset.yml docs-builder#1615 - not yet merged)
  • diff the two pages - some stuff might have been added here and not in the elasticsearch repo

@shainaraskas
Copy link
Collaborator

the reason I'd kill the page is that this page is too tiny and useless to be valuable, which means it would suck to land on it. we should prob always kill pages that are under 10 lines like this unless they disambiguate child pages.

@shainaraskas
Copy link
Collaborator

I do like your additions though ... if you want to, you can keep the page (would still prob recommend killing it) but I would change the xlinks because in most cases we're trying to draw their attention to a specific permission / the list of permissions

@yetanothertw
Copy link
Contributor Author

My only concern about removing it entirely is the gap it leaves in the TOC:
image

At the moment it's sort of a logical equivalent to the Kibana privileges page and if we remove it, it might be confusing, might look like a knowledge gap. 🤷‍♀️

@yetanothertw
Copy link
Contributor Author

yetanothertw commented Aug 26, 2025

Re diffing, it's the opposite, it seems there are additions in the page in the Reference section but not in Deploy and manage.

@shainaraskas
Copy link
Collaborator

@yetanothertw yeah that's why we would put the crosslink in (it would sit in the same spot)

@shainaraskas
Copy link
Collaborator

I also would move your additions over to the other copy of the page :)

@yetanothertw
Copy link
Contributor Author

OK, I see what you mean.

  1. I'll work on refactor applies_to info in security-privileges.md #2215 and will move my additions as part of that issue.
  2. Will keep this PR (for when Add crosslinks to toc: in docset.yml docs-builder#1615 is merged) and delete the page and add an xlink to the nav to the new page.
  3. I'll open another PR to replace links that point to this page with links that will point to the reference page.

yetanothertw added a commit that referenced this pull request Sep 1, 2025
)

The [Elasticsearch privileges page in the Deploy and manage
section](https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/elasticsearch-privileges)
is being replaced with its [counterpart in the Reference
section](https://www.elastic.co/docs/reference/elasticsearch/security-privileges).
This PR replaces all links from within the narrative docs to the correct
(deduplicated and reconciled) page.


Relates to #2718 and #2218
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Reconcile duplicate elasticsearch privileges pages
2 participants