Commit graph

236 commits

Author SHA1 Message Date
Solène Rapenne
464c86c98f
Merge branch 'pr/1542' 2025-09-24 18:41:43 +02:00
parulin
fa5a5c8493
Merge remote-tracking branch 'origin/main' into update-devices-widget-icon 2025-09-21 13:48:44 -04:00
qubedmaiska
04d278b0a4
Merge remote-tracking branch 'parulin/intersphinx' 2025-09-21 13:10:09 -04:00
parulin
69852d017a
Update device widget icon and remove issue link
* The Device Widget icon is updated, taken from
  [qubes-desktop-linux-manager](QubesOS/qubes-desktop-linux-manager/tree/release4.2/)
* As the original PNG was deleted, all the ``how-to-use-*-devices`` have
  been updated too (with a better markup)
* QubesOS/qubes-issues#4692 is closed so the corresponding paragraph has
  been removed.

Note: cherry-picked from #1492
2025-09-19 16:19:06 -04:00
parulin
cde3995d0a
how-to-use-disposables: fix migration to sphinx
- use proper directives (warning, etc.) and roles (samp, menuselection)
- convert an image to a figure with description
- remove useless alt attributes
- proper links (no click here) + fix redirections
- better prompts
2025-09-17 08:38:34 -04:00
parulin
c4d890d7c0
Fix wrong roles warnings and wording 2025-09-15 05:03:50 -04:00
Solène Rapenne
0fcd7d2707
Merge branch 'pr/1517' 2025-09-14 11:52:40 +02:00
Solène Rapenne
26d226b632
Merge branch 'pr/1516' 2025-09-14 11:49:49 +02: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
parulin
c81847a780
Fix typos on how-to-enable-a-service 2025-09-12 17:29:46 -04:00
parulin
90de0563de
Correct typos in how-to-edit-a-policy 2025-09-12 17:22:56 -04:00
parulin
804acc1f65
Clarify how-to-edit-a-policy following review
Following @rapenne-s review:

* make clear that the first method is for the most common policies
* explain how priority works
* provide the user a way to modify the default editor
* some typos

Reading again the help text of `qubes-policy-editor` I made some
corrections.
2025-09-12 17:09:41 -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
6ecfe972a1
merge PR #1494 and fixed conflicts 2025-09-06 07:03:33 -04:00
qubedmaiska
adf0dd0f1c
Merge remote-tracking branch 'parulin/update-how-to-fullscreen' into rst 2025-09-06 06:51:21 -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
Rusty Bird
5912b172a2
How to use disposables: qvm-run -> qvm-run-vm
https://forum.qubes-os.org/t/how-to-make-qvm-run-available-in-debian-templates/35252/3
2025-08-24 08:32:21 +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
parulin
13e9a25b00
Add how-to-enable-a-service
Like cb520b98, this is meant as a way to shorten all the other pages that need
to enable a service. (i.e. split-gpg-2)
2025-08-21 04:46:06 -04:00
parulin
61bcd9647c
Add a link to glossary in how-to-edit-policy
+ minor spelling edit
2025-08-21 03:56:36 -04:00
parulin
cb520b98b4
Add how-to-edit-a-policy
This is meant as a way to shorten all the other pages that need to
change something to the policies. (i.e. split-gpg-2)
2025-08-21 03:49:46 -04:00
parulin
b6a0aa33c9
Merge remote-tracking branch 'origin/rst' into update-how-to-fullscreen 2025-08-18 17:01:16 -04:00
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
parulin
41fae0f5a4
Use :menuselection: when appropriate 2025-08-18 16:26:35 -04:00
parulin
512525748f
Adding rst_epilog, better markup on some pages
Using more appropriate markup and some substitution, mostly on:

* `how-to-install-software.rst`
* `app-menu-shortcut-troubleshooting.rst`
2025-08-18 16:26:30 -04: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
parulin
3ba7a492f0
Change again some languages
Thanks to @tokideveloper !!!
2025-08-09 17:39:16 -04:00
parulin
6f4370f793
Minor cleaning of code highlighting
* Most of text blocks are in fact output blocks
* On qubes-iso-building.rst, try to get something correct for console
  lines starting with a comment
* Fixing a wrong :menuselection: item.

Statistics:

    685 console
     79 text
     44 bash
     35 output
     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
2025-08-08 16:55:35 -04: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
parulin
c977c44bed
Adding screenshots to How to enter fullscreen mode 2025-08-06 17:27:50 -04:00
parulin
0c5100f409
Update How to enter fullscreen mode 2025-08-06 09:43:26 -04: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
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
78654bf052
added space, fixed links 2025-05-28 09:46:41 -04:00
unman
a00b4a18c0
Update How to Install Software page with dnf5 syntax for enabling
repositories
Merge branch 'pr-1442'
2025-05-26 23:29:45 +00:00
qubedmaiska
f487cd4261
update from upstream 2025-05-25 06:03:22 -04:00
Ali Mirjamali
2b028834a6
Fixing existing CI/CD issues 2025-05-18 22:02:46 +03:30
m
fa3b299a51
Merge branch 'QubesOS:main' into main 2025-05-15 15:12:04 -04:00
unman
b594557061
Minor change to headings on update page. 2025-05-15 12:12:18 +00:00
unman
46e4e0a684
Add information on how to update firmware. Merge pr-1437 2025-05-15 12:09:23 +00:00