Skip to content
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

Move edit button out of heading elements #3049

Merged
merged 2 commits into from
Aug 27, 2024

Conversation

colleenmcginnis
Copy link
Contributor

@colleenmcginnis colleenmcginnis commented Aug 27, 2024

Closes #1966

This PR moves the edit button out of the heading elements in the body of the content (edit buttons were already added outside page titles in #3015). This is important because when the edit button is inside the heading element, technically the full text of the heading includes edit appended to the end of the intended heading text. This is getting picked up by Google, but may also cause unexpected results elsewhere including for users using screenreaders.

Screenshot 2024-08-27 at 9 44 20 AM

Note: I opted for updating the HTML and using Bootstrap CSS classes to avoid having to bump the name (-v1 to -v2) of the CSS file. If the user gets the updated HTML with a cached version of the CSS and JavaScript files, the edit button should still be positioned correctly and work as expected.

Copy link

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

Copy link
Member

@bmorelli25 bmorelli25 left a comment

Choose a reason for hiding this comment

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

Wow. You can even copy/paste headings now without the "edit" getting in the way!

@colleenmcginnis colleenmcginnis merged commit 5a15bb9 into elastic:master Aug 27, 2024
5 checks passed
@colleenmcginnis colleenmcginnis deleted the move-edit branch August 27, 2024 21:02
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.

Move Edit links out of headings
2 participants