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

Docs inclusive language #2503

Merged
merged 5 commits into from
Aug 30, 2023
Merged

Docs inclusive language #2503

merged 5 commits into from
Aug 30, 2023

Conversation

christinaausley
Copy link
Contributor

Description

Closes #2453.

To answer (@akeller thoughts?)

See

We progressively need to eliminate usage of "see X link" and replace it with "refer to X link", but there are still about 400 existing references in the next version of docs. You may note I adjusted a handful of these already, but is it worth adjusting all, or cleaning them up as we move forward? Let me know the best use of time here 👍

IP Whitelist

Ideally, we wouldn't use "whitelist", but we refer to IP-Whitelist in our docs. Would this be an exception, or should I go ahead and adjust these references as well?

When should this change go live?

  • This change is not yet live and should not be merged until {ADD_DATE} (apply hold label or convert to draft PR)?
  • There is no urgency with this change.
  • This change or page is part of a marketing blog, conference talk, or something else on a schedule.
  • This functionality is already available but undocumented.
  • This is a bug fix or security concern.

PR Checklist

  • I have added changes to the relevant /versioned_docs directory, or they are not for an already released version.
  • I have added changes to the main /docs directory (aka /next/), or they are not for future versions.
  • My changes require an Engineering review, and I've assigned an engineering manager or tech lead as a reviewer, or my changes do not require an Engineering review.
  • My changes require a technical writer review, and I've assigned @christinaausley as a reviewer, or my changes do not require a technical writer review.

@christinaausley christinaausley added the component:docs Documentation improvements, including new or updated content label Aug 28, 2023
@christinaausley christinaausley self-assigned this Aug 28, 2023
Copy link
Member

@akeller akeller left a comment

Choose a reason for hiding this comment

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

This is huge!! But important! Thanks for your work here.

Regarding links, let's take a best effort approach. As you see them or review new PRs, fix them (and advocate internally for folks opening PRs to be on the look out - don't use "see"!). I don't think we need to fix all of them immediately.

For the IP Whitelist topic, we have an open epic with the product, since it would need to change there first. In the epic, we should leave a comment that this is an exception to inclusive language in our style guide and ask that it be prioritized.

@christinaausley
Copy link
Contributor Author

In the latest commit, I've:

  • Replaced terms for "native images" as an exception.
  • Adjusted terms referencing "abort"

I've also noted all of these adjustments in Confluence, and will give the glossary a shoutout at the next WCoE release (next week!)

Just looking for final approval 👍

Copy link
Member

@akeller akeller left a comment

Choose a reason for hiding this comment

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

All of this sounds great! Can you also add it to our Sept internal release presentation list? All the shoutouts everywhere 🚀

@christinaausley christinaausley merged commit b75513e into main Aug 30, 2023
3 checks passed
@christinaausley christinaausley deleted the docs-inclusive-language branch August 30, 2023 22:01
pepopowitz pushed a commit that referenced this pull request Oct 16, 2024
* abide by inclusive language

* eliminate see

* resolve comments
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
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

Create glossary and PR for inclusive language
2 participants