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

[chore] Accessible links 3 #6051

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

Conversation

jsoref
Copy link
Contributor

@jsoref jsoref commented Jan 23, 2025

The web isn't limited to people who read content with their eyes. Some users use screen readers and other accessibility agents and some people have other reasons for appreciating descriptive links. To that end, check-spelling/spell-check-this includes a rule:

Do not use (click) here links

For more information, see:

(?i)(?:>|\[)(?:(?:click |)here|link|(?:read |)more)(?:</|\]\()

The changes included here are designed to help users who benefit from descriptive links

Copy link
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

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

While I agree with avoiding "here" etc as link text, ensure that you maintain the phrase structure when it is of the form "For xyz, see title of page", instead of (as you've done in a few cases) flipping the order to be "See ... for xyz." Thanks.

Comment on lines 16 to 17
below. See [OpenTelemetry in JavaScript](/docs/languages/js) for more info about
its status. {{% /alert %}}
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
below. See [OpenTelemetry in JavaScript](/docs/languages/js) for more info about
its status. {{% /alert %}}
below. For status details, see [Status and Releases](/docs/languages/js/#status-and-releases).
{{% /alert %}}

Comment on lines 252 to 253
to get details about your [Cloud] environment or [Deployment][]. See the
[list of node detectors](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/detectors/node).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
to get details about your [Cloud] environment or [Deployment][]. See the
[list of node detectors](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/detectors/node).
to get details about your [Cloud] environment or [Deployment]. For more, see the complete
[list of detectors](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/detectors/node).

content/en/docs/languages/net/exporters.md Outdated Show resolved Hide resolved
content/en/docs/zero-code/python/configuration.md Outdated Show resolved Hide resolved
content/en/docs/zero-code/python/configuration.md Outdated Show resolved Hide resolved
content/en/docs/zero-code/python/logs-example.md Outdated Show resolved Hide resolved
content/en/docs/zero-code/python/logs-example.md Outdated Show resolved Hide resolved
@chalin chalin added blocked accessibility Adds accessibility improvements labels Jan 24, 2025
Signed-off-by: Josh Soref <[email protected]>
@jsoref jsoref force-pushed the accessible-links-3 branch from 6fdfec5 to e92fc92 Compare January 24, 2025 01:18
@opentelemetrybot opentelemetrybot requested review from a team January 24, 2025 01:18
@jsoref jsoref force-pushed the accessible-links-3 branch from e92fc92 to a3d4761 Compare January 24, 2025 01:37
@jsoref jsoref force-pushed the accessible-links-3 branch from a3d4761 to fb1d0f9 Compare January 24, 2025 01:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

5 participants