Commit graph

59 commits

Author SHA1 Message Date
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
04d278b0a4
Merge remote-tracking branch 'parulin/intersphinx' 2025-09-21 13:10:09 -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
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
Dr. Gerhard Weck
74a7f49262
Change links to new documentattion 2025-09-12 10:53:23 +02:00
parulin
8436e2ac9f
Create a real Sphinx glossary 2025-09-06 12:09:48 +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
bb37d69f56
update upstream 2025-04-22 03:09:13 -04:00
qubedmaiska
d4461fb4cb
formatting, webarchive links, add icons 2025-02-27 16:10:31 -05:00
Demi Marie Obenour
0250897727 Document how to update system firmware
This is a very important task, but it is often not done due to bad
tools.  Also correct some outdated information on the "how to update
software" page.
2024-08-22 16:35:22 -04:00
unman
df40f5eacf
Add note on policies to glossary 2024-02-18 00:44:53 +00:00
Andrew David Wong
57ea99814e
Fix typo; explain note 2023-02-21 08:13:49 -08:00
Andrew David Wong
1030642ceb
Remove outdated statement
https://forum.qubes-os.org/t/14098/26
2022-10-13 22:54:49 -07:00
Andrew David Wong
7f881d8df9
Change "netvm" to "net qube"
QubesOS/qubes-issues#1015
2021-09-07 23:17:30 -07:00
unman
d0bc9e70a2
Sentence case for titles 2021-07-09 01:06:41 +00:00
Andrew David Wong
28bfb5c224
Capitalize second word in title case compound adjectives
https://github.com/QubesOS/qubes-issues/issues/6756#issuecomment-873385039
2021-07-03 15:43:16 -07:00
Marek Marczykowski-Górecki
3806ecf338
Remove extra newlines at the beginning/end of files
Those are redundant, and yaml parser strips them in fact. By removing
them, loading and saving yaml file without any change indeed produce the
same output. This is useful for prepare_for_translation.py script (which
adds lang and ref tags) - to produce only change that indeed was made.
2021-06-24 16:07:23 +02:00
Andrew David Wong
a015f60087
Fix links 2021-06-21 18:39:21 -07:00
Andrew David Wong
d31155a89e
Add entry for "management qube" 2021-06-20 22:49:09 -07:00
Andrew David Wong
87948a3d0d
Update URL to match title 2021-06-20 20:55:57 -07:00
Andrew David Wong
7c0a29a253
Add entry for "netvm" 2021-06-18 22:27:46 -07:00
Andrew David Wong
0a53418de1
Update glossary
- Add entry for "admin qube"
- Add entry for "named disposable" (QubesOS/qubes-issues#6709)
- Clarify disposable-related definitions (QubesOS/qubes-issues#6709)
- Add "previously known as" terms
- Clarify wording in various entries
2021-06-18 20:34:02 -07:00
Andrew David Wong
ba232b6b58
Improve organization and wording; fix typos 2021-06-18 12:23:43 -07:00
Andrew David Wong
b3c61ed5c0
Clarify definitions 2021-06-18 12:08:33 -07:00
Andrew David Wong
f50d543155
Fix errors 2021-06-18 06:42:30 -07:00
Andrew David Wong
07c130df00
Wrap text and miscellaneous cleanup 2021-06-18 06:25:06 -07:00
Andrew David Wong
50270f435c
Fix links 2021-06-18 03:09:09 -07:00
Andrew David Wong
aea595397f
Mass replace "AppVM" and "TemplateBasedVM" with "app qube"
QubesOS/qubes-issues#1015
2021-06-18 01:55:53 -07:00
Andrew David Wong
e9fe17f2f2
Fix link text capitalization 2021-06-18 01:21:40 -07:00
Andrew David Wong
873da01b7b
Shorten "standalone qube" to "standalone"
Similar to "templates" and "disposables."
QubesOS/qubes-issues#1015
2021-06-18 01:19:44 -07:00
Andrew David Wong
7652e7edf8
Revamp glossary
- Replace "VM" with "qube" (QubesOS/qubes-issues#1015)
- Remove deprecated terms
- Remove some terms that are not Qubes-specific
- Alphabetize entries
- Miscellaneous improvements
2021-06-18 00:48:17 -07:00
Andrew David Wong
6d81f95cc2
Update and reorganize documentation
- Convert "Common Tasks" to "How-to Guides"
  (QubesOS/qubes-issues#6694)
- Make title capitalization consistent across docs
- Fix leftover h1 headings
- Reorganize various pages and topics
- Update permalinks to better match titles
- Create redirects for changed permalinks
- Miscellaneous cleanup

QubesOS/qubes-issues#6701
2021-06-17 05:16:22 -07:00
Andrew David Wong
2c473241a8
Revert "Remove all instances of permalink: in YAML frontmatter"
This reverts commit c815e4c54c.

https://github.com/QubesOS/qubes-issues/issues/6701#issuecomment-862822827
2021-06-16 19:56:25 -07:00
Andrew David Wong
a4cbb51092
Remove vestigial '====' heading syntax
https://github.com/QubesOS/qubes-issues/issues/6701#issuecomment-862060759
2021-06-15 23:53:27 -07:00
Andrew David Wong
f822b70435
Remove redundant titles
First pass for all titles still using the old '=====' syntax

https://github.com/QubesOS/qubes-issues/issues/6701#issuecomment-862060759
2021-06-15 23:48:48 -07:00
Andrew David Wong
0c95b3ae4d
Revert "Remove instances of title: from YAML headers"
This reverts commit 24e6a8a616.

https://github.com/QubesOS/qubes-issues/issues/6701#issuecomment-862060759
2021-06-15 23:19:45 -07:00
Andrew David Wong
c815e4c54c
Remove all instances of permalink: in YAML frontmatter
Converts existing permalink paths into redirect_from entries.

QubesOS/qubes-issues#6701
2021-06-15 22:33:51 -07:00
Andrew David Wong
24e6a8a616
Remove instances of title: from YAML headers
QubesOS/qubes-issues#6701
2021-06-15 22:16:59 -07:00
ctrlaltf24
94d205a2b6
added qvm-convert domU
Relies on https://github.com/QubesOS/qubes-app-linux-img-converter/pull/13
2021-05-10 19:22:02 -07:00
Andrew David Wong
daba836b70
Minor text fixes 2021-04-29 15:08:56 -07:00
AJ Jordan
06a9b2bc93
Don't use "class" technical jargon in the glossary 2021-04-27 03:41:34 -04:00
Tobias Killer
b6cb04c297
Refactor links in order to obey the new convention rule 2021-04-11 00:09:05 +02:00
Maya
820af56761
Add lang + ref tags to frontmatter
Those are fields used by the language switcher to correlate pages across
different languages, even if they have different names/paths/titles.
They are generated with the prepare_for_translation.py script.
2021-03-14 16:18:11 +01:00
Maya
1a92224f8b
Remove content from pages dynamically filled in by a relevant layout
In fact, right now those pages content is duplicated - once included
here and once inserted by the doc-content (or hcl) layout.
2021-03-14 16:18:11 +01:00
Maya
8f8a8e50ea
Normalize frontmatter
- sort keys
- remove permalink from redirects
2021-03-14 16:18:10 +01:00
Maya
67a92614aa
Markdown formatting fixes
- mark all code blocks with ```
- unify empty lines between sections
- adjust list syntax (no space before dash)
- adjust headers to use Atx-style syntax
- remove trailing spaces
2021-03-14 16:18:10 +01:00
ravachol
89053dfaf5
Update tools.md 2021-01-30 17:37:24 +01:00
Andrew David Wong
6da63e3878
Improve cross-linking between pages 2020-11-16 02:14:26 -08:00
Andrew David Wong
9fcde063c4
Clarify the term "domain" 2020-09-16 20:21:36 -05:00