-
-
Notifications
You must be signed in to change notification settings - Fork 41
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
Improve language #150
Conversation
@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.) |
@marmarta: On a separate note, can we change "VM" to "qube" in the file manager actions, per QubesOS/qubes-issues#1015?
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.) |
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. |
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. |
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
Good idea, I've done it in QubesOS/qubes-core-agent-linux#420 |
The test error is related to my comment above: all labels that have links need to be added to the |
Tooltips do not support links.
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 Report
@@ 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
|
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> |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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> |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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>?"
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. :) |
Closes QubesOS/qubes-issues#8057