Commit graph

558 commits

Author SHA1 Message Date
Solène Rapenne
70e6590856
Merge branch 'pr/1556' 2025-11-23 17:41:53 +01:00
Solène Rapenne
2584e38208
Merge branch 'pr/1558' 2025-11-23 17:40:56 +01:00
Solène Rapenne
a7bb615789
Merge branch 'pr/1568' 2025-11-23 17:18:30 +01:00
Solène Rapenne
2360f36b25
Merge branch 'pr/1559' 2025-11-23 16:52:41 +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
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
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
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
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
andrewdavidwong
adb10c47a3
Update Whonix version
See https://github.com/QubesOS/qubes-posts/pull/153
2025-10-23 13:44:51 -07: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
qubedmaiska
bb06e86e46
merge pr #1540, fixed merge conflicts 2025-10-19 19:14:07 -04:00
qubedmaiska
04d278b0a4
Merge remote-tracking branch 'parulin/intersphinx' 2025-09-21 13:10:09 -04:00
parulin
5fd9a6b52f
Remove garbage content introduced with intersphinx 2025-09-21 11:48:12 -04:00
Marek Marczykowski-Górecki
6d0aeb3570
Update 4.3 release schedule 2025-09-19 17:43:54 +02: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
parulin
12f2c7a9bd
Fix minor typo on "how-to edit the rst doc..."
Fix the "reStrucutredText" words. That's a good example on why it is
better not to label link when possible :)

There is other minor typos and inconsitencies (RST instead of rST).
2025-09-15 04:14:19 -04:00
parulin
f0709dd483
Fix minor typos and link on rst related pages 2025-09-13 17:35:21 -04:00
parulin
47252ef12e
Merge remote-tracking branch 'origin/main' into intersphinx 2025-09-13 17:26:08 -04:00
parulin
1a47fc973b
Add intersphinx documentation and clean syntax
* I replaced the `:external:` syntax by a cleaner one, as suggested by
  @maiska.
* An implicit external reference is now impossible.
* Fix duplicate labels warnings
* Minor typos, including the word "orthographicallly" :)
2025-09-13 17:18:52 -04:00
qubedmaiska
d9a6e20f3a
add labeling of sections inside rst docs 2025-09-13 11:16:12 -04:00
qubedmaiska
0f77371239
add screenshots with main branch, remove obsolete images, references to main branch instead of rst for conf.py, .readthedocs.yml, attachment, _ext, use .venv 2025-09-13 09:42:04 -04:00
parulin
c40c0ac302
Install intersphinx extension and edit links
Some anchor links are currently lost on:

* developer/system/template-manager.rst
* user/how-to-guides/how-to-enter-fullscreen-mode.rst
2025-09-13 04:37:05 -04:00
qubedmaiska
0bf898475f
fix references, refactor website style doc and others 2025-09-09 23:30:17 -04:00
qubedmaiska
bd26dee6a4
add info about readthedocs.yml, exchange code-block with code to be consistent 2025-09-09 12:15:52 -04:00
qubedmaiska
1be6e5f9b9
fixed linter warnings 2025-09-09 12:05:31 -04:00
qubedmaiska
e93ddb3796
fixed reference errors, minor enhancements to the docs, fix pyproject.toml, alt text to images 2025-09-09 11:39:34 -04:00
qubedmaiska
4404a5d5f5
merge upstream rst, add screenshots, rewrite how-to-edit-the-website, combine website and markdown-style-guide, enhance how-to-edit-the-rst-documentation and rst style guide, fix errors, added comments to conf.py, links to README & CONTRIBUTING 2025-09-09 05:29:19 -04:00
qubedmaiska
bb4a0b720f
merge upstream and add rst version of the how to edit Markdown and Markdown and website style guide docs 2025-09-08 02:03:08 -04:00
qubedmaiska
7172de20be
WIP, add screenshots, tips&tricks, rename old documentation 2025-09-08 01:57:27 -04:00
qubedmaiska
4d3109bfc2
Add rst files about how to edit the documentation, documentatioon and website style guide in Markdown 2025-09-08 01:24:47 -04:00
qubedmaiska
6ecfe972a1
merge PR #1494 and fixed conflicts 2025-09-06 07:03:33 -04:00
parulin
8436e2ac9f
Create a real Sphinx glossary 2025-09-06 12:09:48 +02:00
qubedmaiska
ff68e782c8
Merge branch 'code_block_prompts_full' into rst 2025-09-06 06:04:30 -04:00
qubedmaiska
6218ea2dce
Merge remote-tracking branch 'parulin/warning-fix' into rst 2025-09-06 05:42:29 -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
parulin
b02eba099e
Fix of tables options and emphasis 2025-08-26 01:43:59 -04: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
Tobias Killer
140789e7fc Merge branch 'rst' into toki_fix_findings 2025-08-23 11:05:37 +02:00
qubedmaiska
44dbd11d12
Merge remote-tracking branch 'alimirjamali/issue-10070-r4_3-release-notes' into rst 2025-08-22 17:38:36 -04:00
Ali Mirjamali
d0f91e88db
Qubes OS r4.3 release notes
resolves: https://github.com/QubesOS/qubes-issues/issues/10070
2025-08-22 20:17:30 +03:30
parulin
06c6503932
Fixing various warnings from sphinx-build
* missing theme options in conf.py
* orphaned pages are tagged as such
* a markup mistake
* duplicate labels
* a code-block marked as python code
2025-08-18 16:52:34 -04:00