Commit graph

157 commits

Author SHA1 Message Date
Ben Grande
f74d725ec0
Add empty line for proper rst list 2026-01-02 16:23:06 +01:00
Solène Rapenne
96fcd9b56b
Merge branch 'pr/1575'
Late GUID and early GUI agent on preloaded disp
2025-12-10 22:51:52 +01:00
Ben Grande
e119bc1643
Note preload autostart refills instead of refresh
For: https://github.com/QubesOS/qubes-core-admin/pull/758
For: https://github.com/QubesOS/qubes-issues/issues/1512
2025-12-03 13:13:53 +01:00
Ben Grande
507dd7d0c7
Late GUID and early GUI agent on preloaded disp
For: https://github.com/QubesOS/qubes-core-admin/pull/757
For: https://github.com/QubesOS/qubes-gui-agent-linux/pull/251
For: https://github.com/QubesOS/qubes-issues/issues/9940
For: https://github.com/QubesOS/qubes-issues/issues/1512
2025-12-03 13:02:42 +01: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
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
qubedmaiska
bb06e86e46
merge pr #1540, fixed merge conflicts 2025-10-19 19:14:07 -04:00
Solène Rapenne
a595faa4e6
Merge branch 'pr/1522' 2025-09-19 14:32:46 +02:00
parulin
98d89c5b13
Replace all anchors links by ref roles
* duplicate titles were removed
* minor fixes for links like "below", etc.
2025-09-16 07:57:56 -04:00
qubedmaiska
1be6e5f9b9
fixed linter warnings 2025-09-09 12:05:31 -04:00
qubedmaiska
6ecfe972a1
merge PR #1494 and fixed conflicts 2025-09-06 07:03:33 -04:00
qubedmaiska
ff68e782c8
Merge branch 'code_block_prompts_full' into rst 2025-09-06 06:04:30 -04:00
Ali Mirjamali
bb5054c462
Initialize asyncio event loop before using it
Python 3.14 (in Fedora 43) throws RunetimeError if event loop is not
initialized before using it.

Resolves: QubesOS/qubes-issues#10188
2025-08-27 21:34:24 +03:30
qubedmaiska
d05bb2b25b
merge changes from pr #1508 excluding admin-api (only spaces in diff) 2025-08-27 00:33:39 -04:00
parulin
11b2626fa2
Merge branch 'rst' into paragraphs-workaround-2 2025-08-26 05:50:29 +00:00
qubedmaiska
7e76afb1a4
Fixes to code block pygemnt's highlighting, add __pychache__ to gitignore
add prompts to terminal sessions where needed
2025-08-23 18:50:45 -04:00
Tobias Killer
3e683cda68 Add newlines where present in Markdown version 2025-08-23 11:31:46 +02:00
parulin
41fae0f5a4
Use :menuselection: when appropriate 2025-08-18 16:26:35 -04:00
parulin
5281f045dc
Trying to fix my mistakes ... 2025-08-16 14:28:31 -04:00
Tobias Killer
cad541c3af
Merge branch 'rst' into toki_fix_findings 2025-08-16 20:05:30 +02:00
qubedmaiska
2d2bcb06a6
Add prompts to all code blocks with bash session 2025-08-15 16:49:01 -04:00
qubedmaiska
d4e09e079f
Merge remote-tracking branch 'parulin/clean-code-block-console' into rst 2025-08-15 13:57:46 -04:00
Tobias Killer
9bd6e80ad7 Improve linking to a section 2025-08-09 22:31:45 +02:00
Tobias Killer
0cfd755295 Fix formattings and other issues
See issue 8180.
2025-08-09 09:50:36 +02:00
parulin
4212c5eda8
Correct code-block lexers
Changing `bash` lexer to `console` because it is appropriate most of
the time. Then after a manual review, some lexer have been changed.

I used `text` each time I was unsure, and for prompt outputs.

The page `/developer/building/qubes-iso-building.rst` still need to be
reviewed (look for lines starting with `$ #`).

I'm not sure about the Windows pages, should we use
[doscon](https://pygments.org/docs/lexers/#pygments.lexers.shell.MSDOSSessionLexer)
or `powershell`?

Is there an appropriate lexer for `guid.conf` content?

**Statistics - Before**
    870 bash
      9 python
      9 c
      2 yaml

**Statistics - After**
    684 console
    111 text
     44 bash
     16 yaml
      9 systemd
      9 c
      8 python
      4 ini
      4 doscon
      2 markdown
      2 desktop
      1 xorg.conf
      1 xml+jinja
      1 xml
      1 kconfig
      1 html

This suggests that the default lexer should be `console`.
2025-08-08 16:55:35 -04:00
parulin
a252dc4338
Use console lexer instead of bash with a prompt 2025-08-08 16:55:34 -04:00
parulin
31c890baa1
Remove duplicate captions and wrong alt formatting of images 2025-08-08 16:52:48 -04:00
Marek Marczykowski-Górecki
f058f77394
manual fixes
Manual fixes after the conversion tool. Mostly based on sphinx warnings.
2025-08-06 02:20:01 +02:00
Marek Marczykowski-Górecki
918eaa479d
Convert to RST
This is done using tools at
https://github.com/maiska/qubes-translation-utilz, commit
4c8e2a7f559fd37e29b51769ed1ab1c6cf92e00d.
2025-08-06 02:19:56 +02:00
Marek Marczykowski-Górecki
e14921b8a3
Rename all md files to rst
This is plain rename without changing content, to help git track files
history.
Do not touch files that are going to be removed during conversion.

Thanks @parulin for the idea!
2025-08-06 02:16:04 +02:00
qubedmaiska
823c5f34ba
admin-api reset to upstream 2025-06-05 20:19:22 -04:00
qubedmaiska
7eaecbd560
update from upstream 2025-06-05 18:54:55 -04:00
qubedmaiska
524928b022
pre-final fixes 2025-06-03 13:51:29 -04:00
qubedmaiska
9f76056671
minor format fixes 2025-05-19 03:10:16 -04:00
Ali Mirjamali
0ead1b03a1
Add the new notes API documentation
related: https://github.com/QubesOS/qubes-issues/issues/899
2025-05-18 20:46:33 +03:30
qubedmaiska
0688e5d7b3
update doc locally 2025-05-14 09:00:17 -04:00
Woolfgm
07b2392c3f
Update qrexec-internals.md 2025-05-14 11:40:56 +02:00
qubedmaiska
bb37d69f56
update upstream 2025-04-22 03:09:13 -04:00
unman
7167897d71
Add information on new device API
Merge branch 'pr-1387'
2025-04-21 10:06:35 +00:00
qubedmaiska
d4461fb4cb
formatting, webarchive links, add icons 2025-02-27 16:10:31 -05:00
qubedmaiska
2093a276b8
merge form upstream 2025-02-21 04:48:20 -05:00
m
8338dab1fd
Merge branch 'QubesOS:main' into main 2025-01-30 16:15:24 -05:00
deeplow
db7938992d
qrexec: add info about QREXEC_REMOTE_DOMAIN
Add information about `QREXEC_REMOTE_DOMAIN` which is still on the qrexec2.md file but not on the V3. However, this still applies, so it should be documented.
2025-01-27 13:49:56 +00:00
Demi Marie Obenour
00785492ad
Document /run/qubes/policy.d/
Useful for users of the feature.
2025-01-23 01:36:49 -05:00
qubedmaiska
2d3bfcb39f
small formatting fixes in markdown 2025-01-22 13:29:16 -05:00
qubedmaiska
8085719b1c
small formatting issues 2025-01-18 15:21:06 -05:00
qm
8003064f51
fixed identation in lists, created sublists of lists, minor formatting fixes 2024-09-22 07:38:20 -04:00
qm
bfbad2b186
removed a TODO comment for better rst conversion 2024-09-20 13:00:42 -04:00
m
3e93bd58b8
preparation conversion rst 2024-08-10 10:48:13 -04:00