Commit Graph

105 Commits

Author SHA1 Message Date
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
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 12408884dd
Clean up YAML titles and create redirect stubs
QubesOS/qubes-issues#6701
2021-06-17 02:40:43 -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 4ff7430960
Remove redundant h1 titles using `#` syntax
https://github.com/QubesOS/qubes-issues/issues/6701#issuecomment-862060759
2021-06-16 00:29:28 -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
Andrew David Wong a660a92634
Merge branch 'resolve-transifex-issues' of https://github.com/tokideveloper/qubes-doc into tokideveloper-resolve-transifex-issues 2021-04-19 16:00:14 -07:00
Tobias Killer 190b740e32
Resolve open issues mentioned on Transifex 2021-04-17 10:31:11 +02:00
deeplow bf64b68bcb
typo 2021-04-16 16:22:32 +00:00
Andrew David Wong d2fa42c1e9
Merge branch 'md-refactoring-links' of https://github.com/tokideveloper/qubes-doc into tokideveloper-md-refactoring-links 2021-04-15 08:57:06 -07:00
Andrew David Wong 26f3a6567b
Fix broken link syntax cases
Thank you to Tokidev for pointing these out.
2021-04-12 13:40:09 -07:00
Tobias Killer b6cb04c297
Refactor links in order to obey the new convention rule 2021-04-11 00:09:05 +02:00
Marek Marczykowski-Górecki 752f1d4ddc
Fix over indented code blocks 2021-03-28 20:58:39 +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 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
Crsi fae89440aa Removed a doubled 'placed' 2021-02-15 19:11:19 +01:00
deeplow f9bc36676d
undo second link 2021-01-06 15:06:25 +00:00
deeplow 58cf8aecc8
fix broken links to github 2021-01-06 15:02:24 +00:00
Andrew David Wong 30e7112f4a
Convert absolute to relative links
Absolute links break automatic onion redirection:
https://groups.google.com/g/qubes-users/c/NJdzP27wvmM/
2020-12-07 17:04:29 -08:00
pierwill dca896aacd
Fix markdown links
Fixes two malformed links in qrexec socket services doc.
2020-11-12 21:19:11 -08:00
Andrew David Wong 3301c561e7
Merge branch 'policy-api' of https://github.com/pwmarcz/qubes-doc into pwmarcz-policy-api 2020-09-18 01:33:31 -05:00
Bryce Guinta 256b02d0d3
Document use of xl info to find total memory
I had to do some digging to figure out why I thought dom0 was reporting an incorrect amount of total memory available, and finally found this command. This document comes up very high in the search results for Qubes memory so I thought I'd put it here since it provides some concrete context to the architecture.
2020-08-29 18:59:09 -04:00
Paweł Marczewski e7a882a497
Add documentation for policy admin API 2020-08-25 14:43:36 +02:00
WillyPillow c8d0ee78d5
Add docs for admin.vm.Volume.Clear. 2020-08-10 11:29:11 +08:00
Paweł Marczewski cc4a4cbf90
admin-api: fix table glitch
The `|` needs to be escaped.
2020-03-30 15:48:07 +02:00