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

Rename Safe mode to Restricted mode #1265

Merged
merged 2 commits into from
Jul 9, 2024

Conversation

Jaifroid
Copy link
Member

@Jaifroid Jaifroid commented Jul 9, 2024

Fixes #1259. "Restricted" is what is used in Visual Studio Code when a file outside of a trusted Repo is opened. I think we risk implying that the mode is fully "Safe" by calling it "Safe". In fact it isn't, because inline JS can still run (at least outside of a Chromium Browser Extension), even though all attached scripts are disabled. It is "safer" than ServiceWorker mode or ServiceWorkerLocal mode, but it isn't 100% "safe".

Additionally, calling it "Safe" makes it sound more attractive than it is: it's a highly restrictive mode in which many things will be broken in all but the most static of ZIMs. It's a good way to view the contents of a ZIM in a relatively static environment before deciding if the ZIM is trusted, but it's not viable for everyday use except for Wikipedia and Stack Exchange ZIMs.

Please note, we never actually released a public version of the app with JQuery mode renamed as Safe mode, so this won't be a confusing change for users. They will simply see that "JQuery mode" (not really intelligible to the average user) is now renamed as "Restricted mode", which better describes what it does.

@Jaifroid Jaifroid added this to the v4.1 milestone Jul 9, 2024
@Jaifroid Jaifroid self-assigned this Jul 9, 2024
@Jaifroid Jaifroid requested a review from audiodude July 9, 2024 09:08
@Jaifroid
Copy link
Member Author

Jaifroid commented Jul 9, 2024

@audiodude There are no actual code changes here, just a mass search-and-rename (with care taken over capitalization and i18n). There may be a few missed cases I'll search for during testing.

Copy link
Collaborator

@audiodude audiodude left a comment

Choose a reason for hiding this comment

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

LGTM

@Jaifroid Jaifroid merged commit 77407af into main Jul 9, 2024
9 checks passed
@Jaifroid Jaifroid deleted the Rename-Safe-Mode-to-Restricted-Mode branch July 9, 2024 17:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename "Safe Mode" to "Restricted Mode"
2 participants