Commit graph

7818 commits

Author SHA1 Message Date
secur1tree
043d66ea4a
Update .readthedocs.yaml
Adding zipped HTML, allows offline users to have the same interface experience
2025-11-16 12:24:38 +00:00
Ben Grande
80c9edac96
Adapt disposable documentation up to 4.3
- Cleared misunderstandings of disposable templates, this word was
  sometimes used interchangeably with disposables;
- Deduplicate content as much as possible;
  - Reference other pages or previous sections;
  - Assume the user has read the previous sections up until the
    current section they are reading;
  - All this deduplication enables easier reading, less clutter, but
    each section doesn't stand by itself, each page does. Some things
    were reinforced on multiple sections, but limited to when
    extremely necessary to learn by reinforcement;
- Structure the files to their distinct use cases:
  - how-to-use-disposables is just the basics to learn what are
    disposables and how to use them, using GUI and CLI alternatives;
  - disposable-customization has everything advanced related to
    disposables, such as advanced usage, creation of disposables
    templates, their customization;
  - disposable-implementation assumes the user understand the previous
    pages and contains a more technical description of disposables and
    preloaded disposables as well as their implementation;
- Prepared usage for a GUIVM setup, avoiding mentions to dom0;
- Usage modes has been organized in GUI first and CLI second, grouped by
  origin such as GUIVM and app qube;
- Usage page restricts itself to "default-dvm", it's name is not
  variable like the Whonix disposable template variant and it is the
  most used disposable template, thus we avoid variables replacement
  that the user should think of the value to a definitive value to use
  when learning. Customization page could not benefit much from this
  though, as it is intended to create alternative disposable templates;
- Usage page links to Tails documentation of why using it on a VM is not
  amensiac, so it can be referenced for users that ask to have Tails in
  a VM for anti-forensics purposes;
- Updated the images to R4.3, nobody deserves to see the Qubes version
  of the Xfce application menu anymore when the new app menu rocks. The
  images also had to be updated because it was fullscreen screenshot
  on a large resolution, making it very difficult to read unless
  opening the image in a new tab and zooming in;
- Implementation page shows preloaded disposables alternatives that were
  once used or considered as a comparative for future studies, to answer
  why a different option is not being used and what requirements a
  replacement must meet;
- Content from previous releases have been deleted;
- Updates to Qrexec policy v4;
- Use rST roles;
- Change non-ASCII quotes and em-dashes to ASCII;
- Standardized text writing style, many people have contributed to these
  pages over the years, there is a lot of different writings styles
  which make the text difficult to map. I rewrote a lot of the
  paragraphs to my liking and understanding of the different stages that
  a user may go through when using disposables, and even on paragraphs
  that I didn't completely write, it was modified to follow the same
  standard with the rest of the pages. The usage must be very simple
  with just the basics, we don't want to scare the user's off of using
  disposables, we want to convince them. The customization is a bit more
  advanced, it assumes a lot more knowledge from the user to make
  decisions by themselves such as customizing applications and qube
  settings, which can affect system security. The implementation details
  do not require reading the code, it just exist to explain what is
  being used and why it was chosen.

Fixes: https://github.com/QubesOS/qubes-issues/issues/10282
For: https://github.com/QubesOS/qubes-issues/issues/1512
2025-11-13 11:44:39 +01:00
qubedmaiska
b4ff92d5f4
fix github issues search links 2025-11-12 17:15:10 -05:00
qubedmaiska
7db23c4466
Merge remote-tracking branch 'deeplow/patch-41' 2025-11-12 17:02:59 -05:00
qubedmaiska
04023e9410
Merge remote-tracking branch 'origin/rsk-domu' 2025-11-12 16:52:02 -05:00
qubedmaiska
9e3b9a61ab
Merge remote-tracking branch 'origin/fedora-templates' 2025-11-12 16:47:38 -05:00
qubedmaiska
d0ccac2008
Merge remote-tracking branch 'deeplow/patch-42' 2025-11-12 16:41:35 -05:00
deeplow
b689b9f084
Remove ".vm." from deviceclass.List call
It should be 'admin.deviceclass.List' instead of 'admin.vm.deviceclass.List' [1].

[1]: 6b978a343e/Makefile (L11)
2025-11-12 12:12:47 +00:00
andrewdavidwong
6d4b9fb2f3
Update Debian intro to reflect that Xfce is the default
Now that the Xfce templates are the default, this part is no longer accurate.
2025-11-07 22:19:55 -08:00
andrewdavidwong
f1c4d54974
Update Fedora template intro to reflect that Xfce template is default
Now that the Xfce templates are the default, this part no longer makes sense.
2025-11-07 22:16:05 -08:00
andrewdavidwong
f0b4ebe87d
Fix statement about RSKs in domUs
This directory exists only in Fedora templates, not Debian templates. See https://github.com/QubesOS/qubes-issues/issues/9044#issuecomment-2016547954.
2025-11-05 20:09:36 -08:00
deeplow
1546da81bf
Fix 4.3 bugs link
Previous link expected a label called "T: bug" and "release-notes, which
no longer seem to exist. They were respectively converted to "type:
task" and "release notes" (without dash)

The incidental urlencoding (removal of some '+' should not make a
difference as far as links are concerned).
2025-11-02 19:20:50 +00:00
qubedmaiska
b29aa05310
reword a subsection of rst documentation build env 2025-10-31 14:51:58 -04:00
qubedmaiska
1040d00e96
Merge remote-tracking branch 'ben-grande/edit-build' 2025-10-31 14:48:57 -04:00
qubedmaiska
ad7ea60af2
Merge remote-tracking branch 'RandyTheOtter/fixes' 2025-10-30 22:22:07 -04:00
Andrew David Wong
8ed09ed690
Merge branch 'pr-1563' 2025-10-30 01:00:12 -07:00
andrewdavidwong
bfec1c8d9b
Add support for Debian 13 on 4.2
QubesOS/qubes-issues#8841
2025-10-30 00:46:10 -07:00
Randy
ac5bbea8c7
how-to-update.rst : use man instead of manpage
Tell the command, not the word
2025-10-29 13:08:14 +00:00
Randy
a1beee7676
how-to-update.rst : tell to run the commands in dom0 terminal 2025-10-28 12:38:49 +00:00
Randy
862d5be63f
how-to-update.rst : try adding code block inside nested list
Add code block inside nested list and collapse the highest level to make the article a bit shorter
2025-10-28 12:10:40 +00:00
parulin
746d4e63f5
Add 4.3.0-rc3 to the R4.3 schedule 2025-10-28 04:20:22 -04:00
Ben Grande
04b669c163
Unify method to build the documentation
With duplication, inconsistencies appears, such as:

- Poetry did not have a version check of sphinx-build;
- Poetry did not discern between git clone and fetching other
  dependencies;
- Virtual environment and poetry documentation were different already;
- Build instructions sometimes used "qubes-doc" or "../qubes-doc".

New structure introduces sections to separate installation, lint and
build process.
2025-10-28 08:20:51 +01:00
Randy
1236df474e
CONTRIBUTING.md : fix links
Fix links to "How to edit the documentation" and "reStructuredText documentation style guide"
2025-10-27 15:27:44 +00:00
Randy
60363a2b72
README.md : fix link
Fix the link to "How to edit the documentation"
2025-10-27 15:24:33 +00:00
Randy
ca2b5312d8
how-to-update.rst : Add examples
1. Add CLI tools usage examples and references to documentation
2. Minor styling in Command-line interface section: make writing a bit more concise, use numbered nested list
2025-10-26 16:00:14 +00:00
qubedmaiska
7b5dd3633a
fixed formatting 2025-10-25 17:49:23 -04:00
qubedmaiska
56db515f58
Merge remote-tracking branch 'GWeck/master' 2025-10-25 17:47:19 -04:00
andrewdavidwong
adb10c47a3
Update Whonix version
See https://github.com/QubesOS/qubes-posts/pull/153
2025-10-23 13:44:51 -07:00
parulin
30ba54cf5f
Enable nitpicky mode and fix last warning
The new header in `resize-disk-image` is far from perfect but it allows
us to enable nitpicky mode by default, so that any contributor is warned
about missing references when building the docs.
2025-10-21 10:38:05 -04:00
parulin
d02ba45697
Merge remote-tracking branch 'origin/windows-toctree' into nitpicky-mode 2025-10-21 10:32:15 -04:00
parulin
99bdce1509
Merge remote-tracking branch 'origin/fix-pr1548-and-1553' into nitpicky-mode 2025-10-21 10:29:11 -04:00
parulin
432873953b
Fix 4.3 schedule and minor improvements
* as [mentioned on the
  forum](https://forum.qubes-os.org/t/version-4-3-0-rc3-not-available-incoherent-with-documentation/36843/6),
  the 4.3 schedule was wrong, so I removed the rc3 date.
* more links to the website news page should help users to figure out
  what the latest release candidate available is.
* I created a direct reference to a useful header on version-scheme.rst
  and updated the text and the references
* There is a minor formatting improvement on the version-scheme.rst and
  a link to the schedule of R4.1 to provide a concrete example.
2025-10-21 10:20:03 -04:00
parulin
f874c19978
Fix warnings introduced by PR#1548 and #1553 2025-10-21 10:18:09 -04:00
qubedmaiska
bb06e86e46
merge pr #1540, fixed merge conflicts 2025-10-19 19:14:07 -04:00
qubedmaiska
755242578c
minor punctuation issue 2025-10-13 16:55:32 -04:00
qubedmaiska
62d4da500a
Merge remote-tracking branch 'marmarta/howtowallpaper' 2025-10-13 16:53:20 -04:00
Marta Marczykowska-Górecka
70a4da382f
Add a Howto on setting wallpapers 2025-10-13 12:22:55 +02:00
qubedmaiska
dddb80be92
Merge remote-tracking branch 'gregoire-mullvad/patch-2' 2025-10-12 18:11:37 -04:00
Dr. Gerhard Weck
051d912de6
Adapt remark on Windows 11 25H2
GUI agent will work only with qvm-features gui set to 1
2025-10-08 10:58:12 +02:00
Dr. Gerhard Weck
5670475377
Add information on Windows 11 25H2
Just a warning about the Qubes graphics driver
2025-10-03 13:06:24 +02:00
Dr. Gerhard Weck
30be50330a
Add information on Windows 11 25H2
just a minor change
2025-10-03 13:00:17 +02:00
deeplow
5139d6c7c8
Update UpdatesProxy to new policy format 2025-10-03 11:05:48 +01:00
Rusty Bird
c1fa7a7ac0
Secondary storage: fix 'btrfs filesystem' invocation 2025-10-02 10:43:04 +00:00
Rusty Bird
c3f74ce704
Secondary storage: fix mounting Btrfs with compression
Btrfs mount options are per whole filesystem, not per mountpoint. If a
filesystem (or a subvolume inside of it) is mounted a second time, the
second set of mount options such as compress= will not be applied.

https://btrfs.readthedocs.io/en/latest/ch-mount-options.html
2025-10-02 10:21:33 +00:00
Rusty Bird
27a6f3127f
Secondary storage: consistently capitalize Btrfs 2025-10-02 10:21:32 +00:00
parulin
2f2f909955
Remove 4.0 warning in autostart-troubleshooting 2025-10-01 08:57:13 -04:00
parulin
1f7bb7961d
Add a warning for outdated grub.cfg file 2025-09-30 09:00:45 -04:00
parulin
33534cb286
Remove useless headers and use warning directives. 2025-09-30 08:55:07 -04:00
parulin
09ffda4c7c
Remove outdated commands to run grub2-mkconfig
Following a [forum
topic](https://forum.qubes-os.org/t/how-to-change-boot-options-for-usb-boot/36387/2),
it seems that the documentation still referenced some outdated way of
running `grub2-mkconfig` command.
2025-09-28 13:22:31 -04:00
parulin
23d6b6fb84
Merge remote-tracking branch 'upstream/main' into windows-toctree 2025-09-28 01:41:06 -04:00