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

[a11y] Fix "read more" occurrence #5317

Merged
merged 4 commits into from
Feb 3, 2022
Merged

Conversation

alaudazzi
Copy link
Contributor

This PR replaces "read more" with accessible content.

Rel: #5306

The generated content in ../reference/api-docs.asciidoc is not in scope.

@alaudazzi alaudazzi added the >docs Documentation label Feb 2, 2022
@thbkrkr
Copy link
Contributor

thbkrkr commented Feb 2, 2022

Should we also replace the occurrences of "read the"?

> grep ' [Rr]ead the' -r docs
docs/orchestrating-elastic-stack-applications/security/saml-authentication.asciidoc:TIP: Make sure you read the complete ...
docs/quickstart.asciidoc:IMPORTANT: Read the <<{p}-upgrading-eck,upgrade notes>>  ...
docs/operating-eck/installing-eck.asciidoc: Read the <<{p}-ga-upgrade,upgrade documentation>> ...

@alaudazzi
Copy link
Contributor Author

@thbkrkr
The last commit fixes more "read" occurrences.

Copy link
Contributor

@thbkrkr thbkrkr left a comment

Choose a reason for hiding this comment

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

I think we shouldn't replace the occurrences when the read doesn't apply to the reader.

docs/release-notes/1.7.0.asciidoc Outdated Show resolved Hide resolved
docs/design/0005-configurable-operator.md Outdated Show resolved Hide resolved
alaudazzi and others added 2 commits February 3, 2022 12:36
Co-authored-by: Thibault Richard <thbkrkr@users.noreply.github.com>
Co-authored-by: Thibault Richard <thbkrkr@users.noreply.github.com>
Copy link
Contributor

@thbkrkr thbkrkr left a comment

Choose a reason for hiding this comment

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

LGTM

@alaudazzi alaudazzi merged commit 31087fe into elastic:main Feb 3, 2022
fantapsody pushed a commit to fantapsody/cloud-on-k8s that referenced this pull request Feb 7, 2023
* Fix read more

* Fix more read occurrences

* Update docs/release-notes/1.7.0.asciidoc

Co-authored-by: Thibault Richard <thbkrkr@users.noreply.github.com>

* Update docs/design/0005-configurable-operator.md

Co-authored-by: Thibault Richard <thbkrkr@users.noreply.github.com>

Co-authored-by: Thibault Richard <thbkrkr@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants