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

Bias-free communication #33706

Merged
merged 2 commits into from
Sep 25, 2024
Merged

Bias-free communication #33706

merged 2 commits into from
Sep 25, 2024

Conversation

guardrex
Copy link
Collaborator

@guardrex guardrex commented Sep 25, 2024

Fixes #33705

IMO, it's a good i-dear to do this every few years to fix problems. This was on my UE tracking issue for Blazor docs, but it's something that I usually do for the whole repo, given that it's just quick search filter stuff.

Notes ...

  • I left "attack" in place, but I preferred to use "cyberattacker" for "attacker" and "adversary."
  • All of our "defense" terminology is related to cybersecurity threats, but I did change "defense" to "defense-in-depth cybersecurity" in a couple of spots.
  • "guard" 👉 "safeguard"
  • "hang" 👉 "stop responding"
  • "attack surface area" 👉 "vulnerabilities"
  • "locked down" 👉 "secured"
  • BTW ... hitting "i.e."/"e.g." updates along the way ... not bias-free stuff, but we're not supposed to use these. Note that I omitted commas for short parenthetical phrases "(for example to {DO SOMETHING})." A comma in those cases didn't seem significant.
  • One "master-detail" item changed to "primary-subordinate."

Not addressed

There are a few articles that are probably OK on he/his/him/her pronoun things because they refer to specific people with a usually obvious gender. Personally, I'd go with something like "user"/"another user" or "user"/"second user," but these are probably OK. Best to check tho in case anyone wants to update the John/Jane examples:

@@ -41,7 +41,7 @@ When downloading files from a different origin than the app, Cross-Origin Resour

## Security considerations

Use caution when providing users with the ability to download files from a server. Attackers may execute [Denial of Service (DoS)](/windows-hardware/drivers/ifs/denial-of-service) attacks, [API exploitation attacks](https://developer.mozilla.org/docs/Web/HTML/Element/a#security_and_privacy), or attempt to compromise networks and servers in other ways.
Use caution when providing users with the ability to download files from a server. Cyberattackers may execute [Denial of Service (DoS)](/windows-hardware/drivers/ifs/denial-of-service) attacks, [API exploitation attacks](https://developer.mozilla.org/docs/Web/HTML/Element/a#security_and_privacy), or attempt to compromise networks and servers in other ways.
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
Use caution when providing users with the ability to download files from a server. Cyberattackers may execute [Denial of Service (DoS)](/windows-hardware/drivers/ifs/denial-of-service) attacks, [API exploitation attacks](https://developer.mozilla.org/docs/Web/HTML/Element/a#security_and_privacy), or attempt to compromise networks and servers in other ways.
Use caution when providing users with the ability to download files from a server. Cyber attackers may execute [Denial of Service (DoS)](/windows-hardware/drivers/ifs/denial-of-service) attacks, [API exploitation attacks](https://developer.mozilla.org/docs/Web/HTML/Element/a#security_and_privacy), or attempt to compromise networks and servers in other ways.

Copy link
Collaborator Author

@guardrex guardrex Sep 25, 2024

Choose a reason for hiding this comment

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

The guidelines call for one word, no hyphen/no space.

https://learn.microsoft.com/en-us/style-guide/militaristic-language

Copy link
Contributor

Choose a reason for hiding this comment

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

Very minor and feel free to refuse or accept: I think both "cyberattackers"and "cyber attackers" are used in the development community, but I think "cyber attackers" might be used more often.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I don't think we have a choice given how explicit they are in the style manual. We've broken with them a bit here and there, but I think AP and Chicago are in agreement. My Chicago is buried at the moment tho ... in a box somewhere around here from the last move 😆.

@@ -401,7 +401,7 @@ Setting the environment variable for `ASPNETCORE_ENVIRONMENT` is only recommende

If an app is capable of responding to requests, obtain request, connection, and additional data from the app using terminal inline middleware. For more information and sample code, see <xref:test/troubleshoot#obtain-data-from-an-app>.

### Slow or hanging app (IIS)
### Slow or nonresponding app (IIS)
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
### Slow or nonresponding app (IIS)
### Slow or non-responding app (IIS)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Not per Chicago.

Copy link
Contributor

Choose a reason for hiding this comment

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

Very minor, take or leave: I think you can go either way technically, but I think non-responding might be a bit more common.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Copy link
Contributor

@wadepickett wadepickett left a comment

Choose a reason for hiding this comment

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

Looks great!

@Rick-Anderson Rick-Anderson merged commit 211cf9e into main Sep 25, 2024
3 checks passed
@Rick-Anderson Rick-Anderson deleted the guardrex/bias-free-communication branch September 25, 2024 22:05
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.

Bias-free communication sweep
3 participants