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

add vale rules for wording #4861

Merged
merged 6 commits into from
Feb 4, 2025
Merged

Conversation

christinaausley
Copy link
Contributor

Description

Adds Vale linting warnings for non-inclusive language and terms to avoid. Closes #1904.

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@christinaausley christinaausley added component:docs Documentation improvements, including new or updated content dx Documentation infrastructure typically handled by the Camunda DX team labels Jan 16, 2025
@christinaausley christinaausley self-assigned this Jan 16, 2025
@christinaausley
Copy link
Contributor Author

@pepopowitz Mind taking a peek to see if I have outlined and placed these properly? I'll loop in the tech writers for final review.

Copy link
Collaborator

@pepopowitz pepopowitz 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 I sent you down the incorrect path, with these rules, I'm sorry!

I also would like to see some proof of what it looks like in GitHub when these rules are violated. That could be commits added in this PR, the review comments screenshotted, and then the commits rolled back....or it could be another PR opened against this branch, and linked to from here.

Let me know if I can help!

Copy link
Collaborator

Choose a reason for hiding this comment

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

Should these apply to the Optimize docs as well? Adding them to the styles/camunda/docsInstance folder means they'll only apply to the main docs instance.

I think you want to move them to the styles/camunda/all folder instead, so that they apply to both the main docs instance and the Optimize instance.

@@ -0,0 +1,10 @@
extends: existence
Copy link
Collaborator

Choose a reason for hiding this comment

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

Unfortunately I can't find anything in the vale docs that explains this very well, but I now realize that I suggested the wrong base rule for these.

If you look at the example here, it extends "substitution" rather than "existence", and defines a "swap" array instead of "tokens". In doing so, it enables the linter to provide a suggestion for the correct value. I think that would give us more actionable feedback in the PR review comments, particularly a commit-able suggestion for the alternative.

I'm a little bit guessing at that, though. We would know for sure if you added some changes to this PR, or opened a PR into this PR with violations.

@christinaausley
Copy link
Contributor Author

I see what you're suggesting here @pepopowitz -- WDYT of the updates?

pepopowitz
pepopowitz previously approved these changes Jan 21, 2025
Copy link
Collaborator

@pepopowitz pepopowitz left a comment

Choose a reason for hiding this comment

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

Yes, exactly! These look great, except two replacements that I think were overlooked.

styles/camunda/all/glossary.yml Outdated Show resolved Hide resolved
@christinaausley
Copy link
Contributor Author

@camunda/tech-writers Are there any additional terms you would like to add here? I'm trying to keep the first iteration pretty minimal, but if I'm missing something that would be helpful please let me know and I can add to this PR before merging 👍

@christinaausley christinaausley marked this pull request as ready for review February 4, 2025 15:47
@christinaausley christinaausley merged commit 621715f into main Feb 4, 2025
8 checks passed
@christinaausley christinaausley deleted the add-vale-linting-for-words branch February 4, 2025 15:48
@christinaausley christinaausley changed the title WIP: add vale rules for wording add vale rules for wording Feb 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:docs Documentation improvements, including new or updated content dx Documentation infrastructure typically handled by the Camunda DX team
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

Lint docs for specific words
3 participants