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.

Sign up for GitHub

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

Jump to bottom

Improved accessibility score #49300

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Improved accessibility score #49300

wants to merge 2 commits into from

Conversation

aakankshabhende
Copy link
Member

@aakankshabhende aakankshabhende commented Jan 6, 2025 •
edited
Loading

Issue

This PR focuses on the accessibility score improvement of the site based on LightHouse report. The accessibility is improved from 91 to 95.

It can be further improved by fixing the colour contrast issue but I'm not sure if the new colour will match our brand colour.

Below are the failing elements (k8s features)
image

Closes: #49298

@linux-foundation-easycla Linux Foundation: EasyCLA
Copy link

linux-foundation-easycla bot commented Jan 6, 2025 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: aakankshabhende / name: Aakanksha Bhende (0c75553, a03344f)

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Jan 6, 2025
@k8s-ci-robot
Copy link
Contributor

Welcome @aakankshabhende!

It looks like this is your first PR to kubernetes/website 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/website has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign divya-mohan0209 for approval. For more information see the Code Review Process.

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

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

@k8s-ci-robot k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Jan 6, 2025
@k8s-ci-robot k8s-ci-robot requested a review from tengqm January 6, 2025 17:46
@k8s-ci-robot k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Jan 6, 2025
@aakankshabhende aakankshabhende marked this pull request as draft January 6, 2025 17:50
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jan 6, 2025
@netlify Netlify
Copy link

netlify bot commented Jan 6, 2025 •
edited
Loading

✅ Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit a03344f
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/677f5e1bedfbe80008af7d9b
😎 Deploy Preview https://deploy-preview-49300--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@sftim
Copy link
Contributor

sftim commented Jan 6, 2025

Some early feedbacl

  • Which score does this PR try to improve? It's not obvious from the description.

@sftim
Copy link
Contributor

sftim commented Jan 6, 2025

BTW we use localizable site strings - see https://kubernetes.io/docs/contribute/localization/#site-strings-in-i18n

@aakankshabhende
Copy link
Member Author

aakankshabhende commented Jan 6, 2025 •
edited
Loading

Which score does this PR try to improve? It's not obvious from the description.

It focuses on the accessibility score of site based on LightHouse report.
@sftim I'll add a detailed description once the PR is ready for review

@sftim
Copy link
Contributor

sftim commented Jan 7, 2025

/area web-development

@k8s-ci-robot k8s-ci-robot added the area/web-development Issues or PRs related to the kubernetes.io's infrastructure, design, or build processes label Jan 7, 2025
@aakankshabhende
Added name param to socials hugo
a03344f 
Signed-off-by: aakankshabhende <[email protected]>
@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jan 9, 2025
@aakankshabhende aakankshabhende marked this pull request as ready for review January 9, 2025 06:00
@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 Jan 9, 2025
sftim
sftim reviewed Jan 12, 2025
View reviewed changes
hugo.toml
Copy link
Contributor

Choose a reason for hiding this comment

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

The changes in this file are not needed.

name_key is a key to a localizable string, so that not only are these already accessible, they are accessible to people who speak a range of languages.

layouts/partials/navbar.html
@@ -1,6 +1,6 @@
{{ $cover := .HasShortcode "blocks/cover" }}
<nav class="js-navbar-scroll navbar navbar-expand navbar-dark {{ if $cover}} td-navbar-cover {{ end }} flex-column flex-md-row td-navbar" data-auto-burger="primary">
<a class="navbar-brand img-fluid" href="{{ .Site.Home.RelPermalink }}"></a>
<a class="navbar-brand img-fluid" href="{{ .Site.Home.RelPermalink }}" aria-label="Link to home page"></a>
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we use a localized string here? See #48756 for an example of how that might be done.

BTW, I might use aria-description rather than aria-label. The label text might be Kubernetes. See if you can A/B test this with someone who uses a related accessibility technology and doesn't know our site especially well.

Copy link
Member Author

Choose a reason for hiding this comment

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

Sure @sftim

@sftim sftim mentioned this pull request Jan 12, 2025
Open
@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 30, 2025
@k8s-ci-robot
Copy link
Contributor

PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@sftim
Copy link
Contributor

sftim commented Feb 10, 2025

@aakankshabhende, would you be willing to either:

  • rebase this PR
  • close this, and open a new similar PR based on current main

I'm afraid this won't merge as-is.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sftim sftim sftim left review comments

@katcosgrove katcosgrove Awaiting requested review from katcosgrove

@tengqm tengqm Awaiting requested review from tengqm

@divya-mohan0209 divya-mohan0209 Awaiting requested review from divya-mohan0209

@reylejano reylejano Awaiting requested review from reylejano

Assignees
No one assigned
Labels
area/web-development Issues or PRs related to the kubernetes.io's infrastructure, design, or build processes cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Improve accessibility
3 participants
@aakankshabhende @k8s-ci-robot @sftim