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 language #150

Merged
merged 8 commits into from
May 12, 2023
Merged

Improve language #150

merged 8 commits into from
May 12, 2023

Conversation

andrewdavidwong
Copy link
Member

@andrewdavidwong andrewdavidwong commented Apr 23, 2023

@andrewdavidwong
Copy link
Member Author

@marmarta, @marmarek: I see that the current content links to https://github.com/Qubes-Community/Contents/blob/master/docs/common-tasks/opening-urls-in-vms.md several times. I think it's a bad idea to link to unofficial documentation from inside of Qubes OS and that we should basically never do this. Do we need to move this piece of documentation into the official docs, or can I simply drop the links to it?

(CCing @taradiddles, the primary editor of that file.)

@andrewdavidwong
Copy link
Member Author

@marmarta: On a separate note, can we change "VM" to "qube" in the file manager actions, per QubesOS/qubes-issues#1015?

  • Copy To Other AppVM... -> Copy to other qube...
  • Move To Other AppVM... -> Move to other qube...
  • Edit In DisposableVM -> Edit in disposable
  • View In DisposableVM -> View in disposable

If so, then I can also edit the mentions of them in this file to match (what will be) the new names.

(As you can see, I also suggest changing from capitalizing every word to sentence case, but you can drop this part if you insist on keeping the former.)

@andrewdavidwong
Copy link
Member Author

I reviewed the failed CI test result, but I'm not sure how to interpret it. If there's anything I need to fix, please let me know.

@andrewdavidwong andrewdavidwong marked this pull request as ready for review May 1, 2023 09:36
@marmarta
Copy link
Member

marmarta commented May 1, 2023

@marmarta, @marmarek: I see that the current content links to https://github.com/Qubes-Community/Contents/blob/master/docs/common-tasks/opening-urls-in-vms.md several times. I think it's a bad idea to link to unofficial documentation from inside of Qubes OS and that we should basically never do this. Do we need to move this piece of documentation into the official docs, or can I simply drop the links to it?

(CCing @taradiddles, the primary editor of that file.)

I vote to move it to official docs. I think this documentation is pretty useful, and hard to find if you don't know what to look for.

marmarta added a commit to marmarta/qubes-core-agent-linux that referenced this pull request May 1, 2023
Use qube instead of VM/AppVM, use the same wording everywhere
and move from every-word-capitized to sentence capitalization

references QubesOS/qubes-issues#1015
references QubesOS/qubes-desktop-linux-manager#150
@marmarta
Copy link
Member

marmarta commented May 1, 2023

@marmarta: On a separate note, can we change "VM" to "qube" in the file manager actions, per QubesOS/qubes-issues#1015?

Good idea, I've done it in QubesOS/qubes-core-agent-linux#420

@marmarta
Copy link
Member

marmarta commented May 1, 2023

The test error is related to my comment above: all labels that have links need to be added to the _handle_urls function in global_config.py, and conversely, the labels you removed need to be removed from the list there. I can fix that function once you finalize this PR too.

@andrewdavidwong
Copy link
Member Author

andrewdavidwong commented May 1, 2023

@marmarta, @marmarek: I see that the current content links to https://github.com/Qubes-Community/Contents/blob/master/docs/common-tasks/opening-urls-in-vms.md several times. I think it's a bad idea to link to unofficial documentation from inside of Qubes OS and that we should basically never do this. Do we need to move this piece of documentation into the official docs, or can I simply drop the links to it?
(CCing @taradiddles, the primary editor of that file.)

I vote to move it to official docs. I think this documentation is pretty useful, and hard to find if you don't know what to look for.

I thought of a third option: Leave the doc where it is (in the community doc repo), but add a warning (somewhere) informing the user that it's an unofficial website. Does this seem better? Worse?

Edit: Probably worse. See discussion on QubesOS/qubes-issues#8166.

@codecov
Copy link

codecov bot commented May 1, 2023

Codecov Report

Merging #150 (9f73cc5) into main (6857dbe) will increase coverage by 0.12%.
The diff coverage is 100.00%.

❗ Current head 9f73cc5 differs from pull request most recent head 4be2f53. Consider uploading reports for the commit 4be2f53 to get more accurate results

@@            Coverage Diff             @@
##             main     #150      +/-   ##
==========================================
+ Coverage   95.90%   96.02%   +0.12%     
==========================================
  Files          43       43              
  Lines        8197     8177      -20     
==========================================
- Hits         7861     7852       -9     
+ Misses        336      325      -11     
Impacted Files Coverage Δ
qubes_config/global_config/global_config.py 86.95% <100.00%> (-0.38%) ⬇️

... and 3 files with indirect coverage changes

This commit replaces all three instances of the link to a community doc
page with links to the official doc table of contents. These new links
are merely placeholders, however, since the specific doc pages we
eventually want here do not exist in the official documentation yet.
These placeholders should be replaced by the more specific official doc
pages once the latter are created.

See QubesOS/qubes-issues#8165 and QubesOS/qubes-issues#8166 for the new
doc pages that don't exist yet.
@@ -515,7 +515,7 @@
<object class="GtkLabel">
<property name="visible">True</property>
<property name="can-focus">False</property>
<property name="label" translatable="yes">Settings related to window management. You will need to restart the affected qubes to see changes made here.</property>
<property name="label" translatable="yes">Decide how windows and tray icons look and behave. Changes you make here will be visible after restarting the system.</property>
Copy link
Member

Choose a reason for hiding this comment

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

That's not precisely true - you only need to restart the affected qubes, not the whole system. So this can be a bit misleading?

Copy link
Member Author

Choose a reason for hiding this comment

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

But the settings in this section are global. The user doesn't get to choose any individual qubes in this section, so what are "the affected qubes"?

@@ -596,7 +595,7 @@ Documentation will open in a disposable qube.</property>
<object class="GtkImage">
<property name="visible">True</property>
<property name="can-focus">False</property>
<property name="tooltip-text" translatable="yes">Unicode parsing is a complex subject prone to vulnerabilities; enabling this will increase your system's attack surface. When disabled, all non-ASCII characters in window titles are replaced with underscores.</property>
<property name="tooltip-text" translatable="yes">"Disallow" means that non-ASCII characters are replaced with underscores in window titles. "Allow" means that all UTF-8 characters are allowed in window titles. The default setting is "disallow" because parsing UTF-8 is complex and prone to vulnerabilities. The "allow" setting will allow you to see, e.g., non-English characters in window titles, but it will increase your system's attack surface.</property>
Copy link
Member

Choose a reason for hiding this comment

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

I'm not a fan of saying those are "English characters", because English does have a bunch of rare, but still existent, letters with diacritics (I've seen it in some places in words like naïve, Charlotte Brontë etc.) - but if you think that ASCII is not understandable enough, we can use this phrasing.

Copy link
Member Author

Choose a reason for hiding this comment

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

But it doesn't say that any characters are "English characters." It just says that if you want to be able to see non-English characters, then the "allow" setting will do that (at the cost of increased attack surface).

This is just intended as a way to anticipate the common question, "How can I get window titles to display in <my_language>?"

qubes_config/global_config.glade Outdated Show resolved Hide resolved
qubes_config/global_config.glade Show resolved Hide resolved
qubes_config/global_config.glade Outdated Show resolved Hide resolved
@marmarta marmarta mentioned this pull request May 11, 2023
@marmarta
Copy link
Member

I think this is basically ready to merge? The test fails are not this PR's fault. Anyway it's a "changes approved" from me.

@andrewdavidwong
Copy link
Member Author

I think this is basically ready to merge? The test fails are not this PR's fault. Anyway it's a "changes approved" from me.

Okay, thanks! Ready to go from my side too. :)

@marmarek marmarek merged commit 0bac706 into QubesOS:main May 12, 2023
@andrewdavidwong andrewdavidwong deleted the language branch May 12, 2023 21:46
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.

Improve language in Qubes Global Config
3 participants