Skip to content

📖 docs: Fix accessibility for assistive tools in documentation notes#5564

Merged
k8s-ci-robot merged 1 commit intokubernetes-sigs:masterfrom
camilamacedo86:doc-test-assesibility
Apr 1, 2026
Merged

📖 docs: Fix accessibility for assistive tools in documentation notes#5564
k8s-ci-robot merged 1 commit intokubernetes-sigs:masterfrom
camilamacedo86:doc-test-assesibility

Conversation

@camilamacedo86
Copy link
Copy Markdown
Member

@camilamacedo86 camilamacedo86 commented Mar 30, 2026

Replace heading tags (h1, h2, h3) inside <aside> elements with <p class="note-title"> and add role="note" attribute. This fixes the document outline for screen readers while maintaining identical visual rendering for sighted users.

Closes: #5457 #5453

@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Mar 30, 2026
@k8s-ci-robot k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Mar 30, 2026
@camilamacedo86 camilamacedo86 force-pushed the doc-test-assesibility branch from e49b07a to 180094d Compare March 30, 2026 19:12
@camilamacedo86 camilamacedo86 changed the title WIP: doc(fix assesibility): Add class and change to improve result for ass… 📖 doc(fix assesibility): Add class and change to improve result for ass… Mar 30, 2026
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 30, 2026
@camilamacedo86 camilamacedo86 changed the title 📖 doc(fix assesibility): Add class and change to improve result for ass… 📖 docs: Fix accessibility for assistive tools in documentation notes Mar 30, 2026
@camilamacedo86 camilamacedo86 changed the title 📖 docs: Fix accessibility for assistive tools in documentation notes 📖 docs: Fix accessibility for assistive tools in documentation notes Mar 30, 2026
@camilamacedo86
Copy link
Copy Markdown
Member Author

Hi @orangecms,

Thank you so much to raise this concern.
Could you please give a look and let me know if that sorted out the issue that you raised?

c/c @vitorfloriano

Copy link
Copy Markdown
Contributor

@orangecms orangecms left a comment

Choose a reason for hiding this comment

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

LGTM!

@k8s-ci-robot
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: camilamacedo86, orangecms

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

<aside class="warning" role="note">
<p class="note-title">The Bootstrapping Problem</p>

When you deploy a webhook into the same cluster that it will validate, you can run into a *bootstrapping issue*:
Copy link
Copy Markdown
Member Author

@camilamacedo86 camilamacedo86 Mar 31, 2026

Choose a reason for hiding this comment

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

Also, we broke , change some CSS (before this PR) that broke the warning notes that should be:

Image

Example; https://book-v3.book.kubebuilder.io/cronjob-tutorial/running-webhook

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Fixed !!!

@camilamacedo86 camilamacedo86 force-pushed the doc-test-assesibility branch 2 times, most recently from ed500f1 to 9c13b5e Compare March 31, 2026 04:58
Replace heading tags (h1, h2, h3) inside <aside> elements with <p class="note-title"> and add role="note" attribute. This fixes the document outline for screen readers while maintaining identical visual rendering for sighted users.
@camilamacedo86 camilamacedo86 force-pushed the doc-test-assesibility branch from 9c13b5e to 090e27a Compare March 31, 2026 05:03
@vitorfloriano
Copy link
Copy Markdown
Contributor

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 1, 2026
@k8s-ci-robot k8s-ci-robot merged commit 9a7fd3c into kubernetes-sigs:master Apr 1, 2026
19 checks passed
@camilamacedo86 camilamacedo86 deleted the doc-test-assesibility branch April 1, 2026 02:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants