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

accessible visual language #579

Merged
merged 2 commits into from
Apr 3, 2024

Conversation

neal-timpe
Copy link
Contributor

Create a warning for only using visual words.
https://issues.redhat.com/browse/CCSENABLE-501

@github-actions
Copy link

github-actions bot commented Jul 13, 2023

🎊 Navigate the preview: https://redhat-documentation-vale-at-red-hat-579.surge.sh 🎊

@github-actions
Copy link

Click here to review and test in web IDE: Contribute

@aireilly aireilly requested a review from rohennes July 25, 2023 14:22
@neal-timpe
Copy link
Contributor Author

These are good suggestions. Sorry I was on pto for a couple of weeks. I didn't meant to ignore this. :)

@aireilly
Copy link
Member

aireilly commented Sep 7, 2023

Here is another approach. We have a new Error rule that provides context to the user about error terms. See https://github.com/redhat-documentation/vale-at-red-hat/blob/main/.vale/styles/RedHat/DoNotUseTerms.yml

Could work here too. For example,

---
extends: substitution
ignorecase: true
level: suggestion
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/visuallanguage/
message: "%s"
swap:
  # Error messages must be single quoted.
  above: 'Try not to use "above". Visual language may be inaccessible to some readers. This can hinder comprehension and inclusivity in your content.'
#etc

Kind of a hack. It's a sub rule that doesn't have a substitution suggestion. Just an explanation. 🤷

@neal-timpe
Copy link
Contributor Author

That actually sounds like what I want to do. There are some items for which I have a swap. But there are others, like colors, where writers really need to be warned not to use them in certain cases.

@neal-timpe
Copy link
Contributor Author

@aireilly I think this one i ready for another look. If you're okay with it, I'm happy to squash.

@neal-timpe
Copy link
Contributor Author

@aireilly Added your last update and squashed.

Copy link
Member

@aireilly aireilly left a comment

Choose a reason for hiding this comment

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

/lgtm

🥇 thank you for hanging in there Neal! The effort is much appreciated.

@aireilly aireilly merged commit 79a41e3 into redhat-documentation:main Apr 3, 2024
4 checks passed
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.

2 participants