Commit graph

134 commits

Author SHA1 Message Date
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
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
m
b7c6ff3cc9
preparation rst conversion 2024-07-28 12:04:31 -04:00
Piotr Bartman
3cec58bf7d
q-dev: update docs 2024-06-30 11:26:54 +02:00
Marek Marczykowski-Górecki
7598bbe156
Various formatting fixes 2024-05-21 16:36:00 +02:00
unman
b29e332c6b
Merge branch 'pr-1399' 2024-05-05 03:16:44 +00:00
Fl1tzi
8552da57b7
admin-api: add missing admin.vm.deviceclass.List 2024-05-01 21:43:01 +02:00
Dmitry V. Levin
7a15cd1a16
Fix a few typos 2024-04-26 08:00:00 +00:00
ooops
896aaf5681
Edit for grammar and clarity qrexec.md 2024-03-02 02:11:33 +01:00
unman
201592f172
Formatting for clarity on qrexec.md 2023-12-19 15:07:10 +00:00
unman
bb860d3159
Clarify location and use of qrexec policy files 2023-12-19 15:01:57 +00:00
Skyler Ferris
38a776a3c6
Use the 4.1 policy file location and format.
The current document still refers to /etc/qubes-rpc/policy and uses
the old 3-column format. This commit updates it to use
/etc/qubes/policy.d and and 5+-column format.

Additionally, correct a technical inaccuracy in the final example
(the policy which the reader is instructed to create denies requests
from source_vm2 with the +testfile1 argument, but the prose states
that it will be accepted).
2023-12-06 19:09:04 -08:00
Andrew David Wong
ab6125ac3f
Move Admin API table back into main document
https://groups.google.com/g/qubes-devel/c/ASj7tehn1G0/m/jhLmFjdMBwAJ
2022-09-08 17:29:50 -07:00
deeplow
900656fc7c
note possibility to add rpc services in app qube
The technical possibility can be found here: https://github.com/QubesOS/qubes-issues/issues/3003
2021-12-14 10:43:24 -05:00
Andrew David Wong
a3364eed21
Remove specific Qubes version refs and warn against this mistake 2021-08-13 02:45:58 -07:00
Andrew David Wong
a18174dc5e
Fix capitalization; update terms (QubesOS/qubes-issues#6769)
Thank you to @unman for the initial sentence case pass.
2021-07-09 05:10:44 -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
4017d11de3
Run script to add 'ref' parameters 2021-06-24 18:19:05 +02: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
ef620f97a7
Refactor Admin API page 2021-06-22 01:25:49 -07:00
Andrew David Wong
e451f92cde
Update attachment paths 2021-06-18 05:46:02 -07:00
Andrew David Wong
60bd80ad25
Revert "Update attachment paths"
This reverts commit e5a21f7488.
2021-06-18 05:39:47 -07:00
Andrew David Wong
e5a21f7488
Update attachment paths 2021-06-18 05:02:02 -07:00
Andrew David Wong
76150ac9d3
Fix links 2021-06-17 07:01:53 -07:00