Commit Graph

90 Commits

Author SHA1 Message Date
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
Andrew David Wong
6bedebbb77
Merge branch 'policy' of https://github.com/pwmarcz/qubes-doc into pwmarcz-policy 2020-03-18 11:10:48 -05:00
pierwill
9ba79fda5a
Edit qrexec sockets docs
Simplify description in "How it works" section and
expand abbreviation for "file descriptor."
2020-03-06 14:28:29 -08:00
pierwill
14fb3fd63a Add newlines to qrexec socket services docs 2020-03-05 18:03:10 -08:00
Paweł Marczewski
1aacec4ab9
Add documentation for policy internals
Describes changes in QubesOS/qubes-core-qrexec#30.
2020-03-02 14:44:55 +01:00
Paweł Marczewski
1729b078dd
Describe creating a socket-based service 2020-02-28 18:52:00 +01:00
Marek Marczykowski-Górecki
e0d5798105
qrexec: add info the service files needs to be executable 2020-02-24 01:37:53 +01:00
Paweł Marczewski
5eadba0512
qrexec-internals: describe "QUBESRPC ..." command 2020-02-14 11:29:47 +01:00
Paweł Marczewski
b97835c729
qrexec-internals: use MSG_TRIGGER_SERVICE3 name 2020-02-14 11:28:35 +01:00
Paweł Marczewski
38ff5470ce
Rewrite qrexec-internals examples
New diagrams (PR: QubesOS/qubes-attachment#30).

Add third use case (VM-dom0).

Attempt to make more readable by omitting some details, and
different formatting (less bullet points).
2020-02-11 11:40:55 +01:00
Andrew David Wong
1f8c64fd6e
Merge branch 'import-with-size' of https://github.com/pwmarcz/qubes-doc into pwmarcz-import-with-size 2020-01-23 03:56:59 -06:00
Andrew David Wong
d5470f5a81
Merge branch 'qrexec-internals-further-work' of https://github.com/pierwill/qubes-doc into pierwill-qrexec-internals-further-work 2020-01-23 03:56:09 -06:00
Pawel Marczewski
16ffa0ba76
Document admin.vm.volume.ImportWithSize
See QubesOS/qubes-core-admin#309.
2020-01-20 09:49:21 +01:00
pierwill
53673f00ce
Fix typos 2019-12-27 10:50:34 -08:00
pierwill
5bc91a4bcd
Edit qrexec command line tools descriptions 2019-12-22 14:44:56 -08:00
pierwill
8e12613108
Edit wording of qrexec-client example 2019-12-05 22:29:06 -08:00