Skip to content

Conversation

yetanothertw
Copy link
Contributor

@yetanothertw yetanothertw commented Sep 4, 2025

As part of replacing the Elasticsearch Built-in roles page in the Deploy and manage section with its counterpart in the Reference section this PR will retire the existing page in the Deploy and manage section and instead link to the correct, deduplicated page in the Reference section
Relates to #2218 and #2738

  • I've had to update a few more links that were pointing to the page in the Deploy and manage section.

  • The TOC with the xlink looks right on the preview (Click Built-in roles in the nav):
image

@yetanothertw yetanothertw marked this pull request as ready for review September 16, 2025 16:28
@yetanothertw yetanothertw requested a review from a team as a code owner September 16, 2025 16:28
@yetanothertw
Copy link
Contributor Author

@theletterf has confirmed that adding crosslinks to TOCs was tested and ready to use. Thank you, Fabri!

@yetanothertw yetanothertw self-assigned this Sep 16, 2025
Copy link
Collaborator

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

beautiful! one toc labeling suggestion (hypothetically could extend to the target page for clarity)

- file: users-roles/cluster-or-deployment-auth/user-roles.md
children:
- file: users-roles/cluster-or-deployment-auth/built-in-roles.md
- title: "Roles"
Copy link
Collaborator

Choose a reason for hiding this comment

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

to differentiate from creating your own roles

Suggested change
- title: "Roles"
- title: "Built-in roles"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks, @shainaraskas , that's a good point!

Fabrizio was wondering if we should somehow indicate to users that we're going to send them to the Reference section. Something like this maybe? Wdyt?

Suggested change
- title: "Roles"
- title: "Built-in roles (Reference)"

Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't agree with this really. I think the ux of the links should be altered so if it's an xref, it has a little icon or something. you can do it if you want but it isn't sustainable and doesn't look cute

@yetanothertw yetanothertw merged commit 0a07563 into main Sep 17, 2025
6 checks passed
@yetanothertw yetanothertw deleted the roles-xref-toc branch September 17, 2025 15:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants