Skip to content
This repository was archived by the owner on Nov 6, 2023. It is now read-only.

Change Naming Convention - Block/Allow Listing for Clarity and Inclusion - #19571

Merged
zoracon merged 6 commits into
EFForg:masterfrom
zoracon:refactor/renaming-listing
Oct 2, 2020
Merged

zoracon merged 6 commits into
EFForg:masterfrom
zoracon:refactor/renaming-listing

Conversation

@zoracon

@zoracon zoracon commented Sep 9, 2020

Copy link
Copy Markdown
Contributor

Note: If there's any functional problems that occur from this renaming, please feel free to comment. However, this is not a debate forum for allowlist vs. blocklist

Open Source Community Examples:

@zoracon zoracon changed the title Refactor: Change Naming Convention for Clarity and Inclusion Refactor: Change Naming Convention of Block/Allow Listing for Clarity and Inclusion Sep 9, 2020
@zoracon zoracon changed the title Refactor: Change Naming Convention of Block/Allow Listing for Clarity and Inclusion Change Naming Convention - Block/Allow Listing for Clarity and Inclusion Sep 9, 2020
Comment thread docs/es/faq.md Outdated
JavaScript no es seguro).

### [¿Por qué utilizar una lista blanca de sitios que admiten HTTPS? ¿Por qué no pueden intentar utilizar HTTPS para cada sitio, y sólo volver a HTTP si no está disponible?](#why-use-a-whitelist-of-sites-that-support-https-why-cant-you-try-to-use-https-for-every-last-site-and-only-fall-back-to-http-if-it-isnt-available)
### [¿Por qué utilizar una lista blanca de sitios que admiten HTTPS? ¿Por qué no pueden intentar utilizar HTTPS para cada sitio, y sólo volver a HTTP si no está disponible?](#why-use-a-allowlist-of-sites-that-support-https-why-cant-you-try-to-use-https-for-every-last-site-and-only-fall-back-to-http-if-it-isnt-available)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

"lista blanca" still translates as "white list" literally.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This is true, I am working internally to get a proper translation of this term since Spanish is a secondary language for me personally.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

¿Por qué utilizar una lista de sitios aprobados que admiten HTTPS?

@pipboy96

pipboy96 commented Sep 10, 2020 •

Copy link
Copy Markdown
Contributor

@zoracon I understand why make this change in user-facing parts, but is the use of this term still problematic if it is not user-facing (like file names)? I can imagine utils/ruleset-whitelist.csv possibly being hardcoded somewhere outside our project. Maybe add a symlink for this file if renaming it is crucial?

Also, entire utils/mk-client-(white|allow)list directory is unused, it's a legacy tool from era we still used XPCOM and had SSL Observatory.

@pipboy96 pipboy96 added i18n Internationalization and localization related issues and PRs docs and removed i18n Internationalization and localization related issues and PRs labels Sep 10, 2020

@cschanaj cschanaj left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Inclusive and descriptive terminologies are great for open source projects. I believe it would be awesome if we could take the opportunities to improve our documentation as well. Just one thing that is not strictly functional, and could be fixed possibly later.

Thank you for the work 👍

Comment thread docs/en_US/faq.md
* [Will there be a version of HTTPS Everywhere for IE, Safari, or some other
browser?](#will-there-be-a-version-of-https-everywhere-for-ie-safari-or-some-other-browser)
* [Why use a whitelist of sites that support HTTPS? Why can't you try to use
* [Why use a allowlist of sites that support HTTPS? Why can't you try to use

@cschanaj cschanaj Sep 10, 2020 •

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I find this question in the FAQ is misleading on how HTTPS Everywhere works. It is also inconsistent with the terminology we use. I believe this question would be better rephrased to avoid confusion.

HTTPS Everywhere use a collection of peer-reviewed rulesets to upgrade insecure HTTP connections to HTTPS. We also use the terminology "Add a rule for this site" on the extension user interface, our users "Enable"/ "Disable" rules with checkbox as needed.

Would something like Why use bundled rulesets to upgrade insecure connections to HTTPS? better?

P.S. I am not a native English speaker, so please forgive me if I am asking a weird question.

@pipboy96 pipboy96 Sep 10, 2020 •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I would suggest "Why not just redirect all websites by default?" "Why not redirect every possible website?". The simplest wording possible is often the best one.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I can change the wording, just have to coordinate a small effort to get the translation. I can schedule that into the next round of documentation updates. Wanted to focus on this renaming portion first. I will note this in the documentation items that need to be done.

Thank you both so much for reviewing with great care and compassion.

@zoracon

zoracon commented Sep 10, 2020

Copy link
Copy Markdown
Contributor Author

@zoracon I understand why make this change in user-facing parts, but is the use of this term still problematic if it is not user-facing (like file names)? I can imagine utils/ruleset-whitelist.csv possibly being hardcoded somewhere outside our project. Maybe add a symlink for this file if renaming it is crucial?

Also, entire utils/mk-client-(white|allow)list directory is unused, it's a legacy tool from era we still used XPCOM and had SSL Observatory.

@pipboy96 Any code or files that is user facing or not, other developers out there like you all will see it. Which is enough reason for me to change it to something more inclusive.

I was contemplating removing this directory (mk-client) all this together, so this encourages me to do just that.

@zoracon

zoracon commented Oct 1, 2020

Copy link
Copy Markdown
Contributor Author

Tagging in @andresbase for Spanish translation for "Allow List"

Comment thread docs/es/faq.md Outdated
@@ -15,7 +15,7 @@ recursos [enumerados aquí](https://www.eff.org/https-everywhere/development).
* [¿Por qué utilizar una lista blanca de sitios que admiten HTTPS? ¿Por qué

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

[¿Por qué utilizar una lista de sitios aprobados que admiten HTTPS? ¿Por qué

@andresbase

Copy link
Copy Markdown

Allow List = Lista de Sitios Aprobado
Which more directly reads as list of allowed sites.
Or you could use a shorter "Lista de aprobados". It's context dependent but I added comments to the sections I could find the term.

Comment thread docs/es/faq.md Resolved
@zoracon
zoracon merged commit a00e6a6 into EFForg:master Oct 2, 2020
@zoracon
zoracon deleted the refactor/renaming-listing branch October 2, 2020 00:49
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants