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

Improve the inclusivity of the language in Access_Control_Cheat_Sheet.md #402

Merged
merged 4 commits into from Jun 2, 2020
Merged

Improve the inclusivity of the language in Access_Control_Cheat_Sheet.md #402

merged 4 commits into from Jun 2, 2020

Conversation

@ben-dale
Copy link
Contributor

@ben-dale ben-dale commented Jun 1, 2020

This change improves the inclusivity of the language in the Access Control cheat sheet.

Please let me know if I've made any errors - first time contributor!

@ben-dale ben-dale requested review from mackowski, rbsec and ThunderSon as code owners Jun 1, 2020
Copy link
Contributor

@rbsec rbsec left a comment

Hi @ben-dale,

Thanks for submitting these. Most of these changes are good, but I've made a few comments on a few specific ones. In some cases you're suggesting changes to words that aren't quite synonymous (for example "clearly" and "precisely"), which in some cases is changing the emphasis of what's being said.

Many of the readers of these cheat sheets don't have English as their first language, so where we can we try and keep the language simpler (as much as you can in technical documents), so things like changing "easy to administer" (a fairly common phrase) to "accessible to administer" (almost never used, only a small handful of results on Google) seems to be adding complexity to the language without providing any additional clarity.

@ThunderSon @mackowski any thoughts?

cheatsheets/Access_Control_Cheat_Sheet.md Outdated Show resolved Hide resolved
cheatsheets/Access_Control_Cheat_Sheet.md Outdated Show resolved Hide resolved
cheatsheets/Access_Control_Cheat_Sheet.md Outdated Show resolved Hide resolved
cheatsheets/Access_Control_Cheat_Sheet.md Outdated Show resolved Hide resolved
cheatsheets/Access_Control_Cheat_Sheet.md Outdated Show resolved Hide resolved
@ThunderSon
Copy link
Contributor

@ThunderSon ThunderSon commented Jun 1, 2020

I agree with the points discussed. It is important to keep in mind our audience, and the meaning of the sentence.
Another point would be to cross reference with the following comment as this sheet will be archived in the coming week.

…d in aid of clarity of language
@ben-dale
Copy link
Contributor Author

@ben-dale ben-dale commented Jun 1, 2020

@ThunderSon @rbsec Thank you greatly for your constructive comments, I perhaps jumped the gun a couple of times! In trying to make them more inclusive I perhaps could have made them less accessible to others, so thank you for casting your eyes over this change.

@ThunderSon I wasn't aware that there were cheat sheets due to be archived! Sorry I missed that. I'll keep that comment handy going forward.

Thank you again, both! Let me know if there are any other changes to me made.

cheatsheets/Access_Control_Cheat_Sheet.md Outdated Show resolved Hide resolved
@ThunderSon ThunderSon merged commit ef76d95 into OWASP:master Jun 2, 2020
2 of 3 checks passed
2 of 3 checks passed
link-check link-check
Details
lint
Details
Publishing Check
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants