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

Update Qubes doc #1568

Merged
merged 1 commit into from
Nov 28, 2022
Merged

Update Qubes doc #1568

merged 1 commit into from
Nov 28, 2022

Conversation

nopeitsnothing
Copy link
Contributor

@nopeitsnothing nopeitsnothing commented Jul 21, 2022

Add better documentation to Qubes OS entry

Affected link: https://www.privacyguides.org/qubes/

Changes so far:

  1. How does Qubes OS work?
  2. Should I use Qubes?
  3. Copying and Pasting Text
  4. File Exchange
  5. Inter-VM Interactions
  6. Additional Resources
  • add source code (GitHub) link
  • update Qubes OS card
  • add some more description to Knowledge Base:
  • further explain Xen hypervisor
  • some description of the goal of Qubes OS
  • explain how qubes (formerly appVMs) work
  • explain compartmentalization in Qubes OS/across appVMs
  • explain color coding etc.
  • few sentences on inter-vm interactions

Resolves: #1465 - comment concerns and questions there to avoid cruft here

@nopeitsnothing nopeitsnothing temporarily deployed to preview July 21, 2022 14:37 Inactive
@github-actions

This comment was marked as outdated.

docs/qubes.en.md Outdated Show resolved Hide resolved
docs/qubes.en.md Outdated Show resolved Hide resolved
@d4rklynk
Copy link
Contributor

You should stick with the buttons at the bottom

@d4rklynk
Copy link
Contributor

I think a schema would be appropriate for qubesos

@nopeitsnothing nopeitsnothing temporarily deployed to preview July 22, 2022 11:01 Inactive
@nopeitsnothing nopeitsnothing temporarily deployed to preview July 22, 2022 11:08 Inactive
@nopeitsnothing nopeitsnothing mentioned this pull request Jul 22, 2022
9 tasks
@dngray dngray added the c:os operating systems and related topics label Jul 25, 2022
@nopeitsnothing nopeitsnothing marked this pull request as draft July 28, 2022 17:41
@nopeitsnothing nopeitsnothing marked this pull request as ready for review August 17, 2022 08:51
@jonaharagon
Copy link
Member

jonaharagon commented Aug 17, 2022

I think this LGTM at a glance, but I do want to go through this later tonight and update some of the wording to make it more stylistically similar to the rest of the website (we shouldn't use words like 'users,' etc. I'm not sure if we have style guidelines actually published anywhere). Also, if this is complete could you update the checklist on the original issue? :)

docs/basics/qubes-overview.md Outdated Show resolved Hide resolved
docs/basics/qubes-overview.md Outdated Show resolved Hide resolved
docs/basics/qubes-overview.md Outdated Show resolved Hide resolved
docs/desktop.en.md Outdated Show resolved Hide resolved
docs/desktop.en.md Outdated Show resolved Hide resolved
docs/desktop.en.md Outdated Show resolved Hide resolved
docs/desktop.en.md Outdated Show resolved Hide resolved
docs/os/qubes-overview.en.md Outdated Show resolved Hide resolved
docs/os/qubes-overview.en.md Outdated Show resolved Hide resolved
docs/os/qubes-overview.en.md Outdated Show resolved Hide resolved
docs/os/qubes-overview.en.md Outdated Show resolved Hide resolved
docs/os/qubes-overview.en.md Outdated Show resolved Hide resolved
docs/os/qubes-overview.en.md Outdated Show resolved Hide resolved
docs/os/qubes-overview.en.md Outdated Show resolved Hide resolved
@matchboxbananasynergy
Copy link
Contributor

@jonaharagon

Make sure the changes I made in 7a3f704 make sense. I think the standalone Qubes page doesn't make sense in our recommendations section, so I've combined the Linux and Qubes pages into a single "Desktop/PC" recommendation page.

Not sure if this makes a lot of sense. It says "Desktop/PC" but has Tux as the icon, and the page starts talking about Linux distributions right away and then lists Qubes, which isn't really a Linux distribution. I'm not 100% opposed to combining the two pages or have a general desktop OS page, but it would need a serious refactoring of the Linux page which I think is out of scope for this PR.

I would leave the Qubes page in Recommendations as it was for now so that we can add the additional information about Qubes, and then decide whether we want to reorganize the content.

@nopeitsnothing
Copy link
Contributor Author

nopeitsnothing commented Oct 28, 2022

I propose moving Qubes OS to a new section like Security Focused Distributions. There's an anonymity focused section already:

Qubes-OS

@nopeitsnothing nopeitsnothing requested review from jonaharagon and removed request for dngray October 28, 2022 23:48
![Colored border](../assets/img/qubes/r4.0-xfce-three-domains-at-work.png)
<figcaption>Qubes window borders, Credit: Qubes Screenshots</figcaption>

## Should I use Qubes?
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
## Should I use Qubes?
## Should I use Qubes?

I don't understand why this is the heading that was chosen here.

Nothing below this heading elaborates on the question of "Should I use Qubes". It merely lists a few features and provides some more context into how communication across VMs is handled. Can someone shed some light on why this wording was chosen?

Copy link
Contributor Author

@nopeitsnothing nopeitsnothing Oct 30, 2022

Choose a reason for hiding this comment

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

Nothing below this heading elaborates on the question of "Should I use Qubes". It merely lists a few features and provides some more context into how communication across VMs is handled. Can someone shed some light on why this wording was chosen?

Because I wrote it this way. Your wording makes no sense, I am the only “someone” that can explain why it was written this way.

One might consider the tone when replying to someone online, as it can be misread or misconstrued from the way they wrote it, which, in this case, sounds passive-aggressive at best. I would prefer a solution offered in the conversation, as opposed to stating what is wrong without offering it.

See my proposed change in 25f4f94.

Copy link
Contributor

@matchboxbananasynergy matchboxbananasynergy Oct 30, 2022

Choose a reason for hiding this comment

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

Because I wrote it this way. Your wording makes no sense, I am the only “someone” that can explain why it was written this way.

Multiple people have made changes to this document, and I did not know whether this was written by you originally, or if it was added by someone else after the fact. Furthermore, even if you were the one to initially put that heading in, I was wondering why it was left untouched when others reviewed the PR. Hence, I was not directing this question exclusively to you, but you as well as others that have changed things in the PR thus far.

One might consider the tone when replying to someone online, as it can be misread or misconstrued from the way they wrote it, which, in this case, sounds passive-aggressive at best. I would prefer a solution offered in the conversation, as opposed to stating what is wrong without offering it.

I apologize if the way I worded anything came across as passive aggressive, which was not my intention. The reason why I did not propose a change at that point was because I wanted to first get some context on the decision to phrase it that way, which may have convinced me it made sense.

You shouldn't assume the worst of people. Sometimes, people aren't trying to be passive-aggressive, but are rather posing a genuine question. A lot of drama can be avoided if you give people the benefit of the doubt.

See my proposed change in 25f4f94.

I think that looks a lot better, thanks!

Copy link
Contributor Author

@nopeitsnothing nopeitsnothing Oct 30, 2022

Choose a reason for hiding this comment

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

I was hoping so. In the meantime, I don't think I have any more changes unless @dngray or other PG staff recommend anything specific. I'm open to suggestions. I think going into great detail about qrexec, inter-vm pipelines, etc., would just bewilder and frustrate the average person, so I will leave out more technical things.

Copy link
Member

Choose a reason for hiding this comment

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

The Qubes OS community is active and naturally Qubes OS docs is where you should be going for authority on all things Qubes. I like to think of this page as a showcase of some of the main reasons why you may use Qubes OS though from a high level - if that makes sense.

@nopeitsnothing
Copy link
Contributor Author

nopeitsnothing commented Oct 30, 2022

It says "Desktop/PC" but has Tux as the icon, and the page

Ask @jonaharagon. I did not change the icons for this page.

BUT, I can say it makes sense having this title, since you only recommend Linux Desktop OS on the website, and those are all Linux distributions suited for use on desktop which are listed in the cards.

@dngray dngray modified the milestones: v2.29, v2.18 Nov 28, 2022
docs/os/qubes-overview.en.md Outdated Show resolved Hide resolved
docs/os/qubes-overview.en.md Outdated Show resolved Hide resolved
Co-Authored-By: Sharp-tailed Grouse <sharptail@riseup.net>
Co-authored-by: matchboxbananasynergy <107055883+matchboxbananasynergy@users.noreply.github.com>
@dngray dngray merged commit e3ee1cf into privacyguides:main Nov 28, 2022
@privacyguides-bot
Copy link
Collaborator

This pull request has been mentioned on Privacy Guides. There might be relevant details there:

https://discuss.privacyguides.net/t/v2-29/10471/1

@nopeitsnothing nopeitsnothing deleted the pterocles/update-qubes branch December 3, 2022 23:15
@dngray dngray removed this from the v2.29 milestone May 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c:os operating systems and related topics
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update Qubes page
6 participants