Git-Mirrors/qubes-doc
1
0
Fork 0
mirror of https://github.com/QubesOS/qubes-doc.git synced 2024-12-14 18:24:32 -05:00
Code Issues Packages Projects Releases Wiki Activity
6,555 Commits 5 Branches 2,526 Tags 87 MiB
8f4fced9a8
Commit Graph

303 Commits

Author SHA1 Message Date
deeplow
185f33eb7e
implemented requested changes 2021-06-17 11:29:54 -04:00
deeplow
0a6f37156e
update 7-year-old test-bench machine setup 
Updates the developer documentation for remote test bench
 2021-06-17 11:29:52 -04: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
84d3334325
Update doc guidelines about h1 headings and titles 
QubesOS/qubes-issues#6701
 2021-06-16 21:49:49 -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
aca8ed14c7
Normalize instances of redirect_from: 
QubesOS/qubes-issues#6701
 2021-06-15 22:24:44 -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
6043c6e51d
Improve documentation guidelines page 
- Create separate section for editing doc index
- Link to how-to-edit-doc-index section in contrib guide
- Link to how-to-edit-doc-index section in core vs. external section
- Link to how-to-add-images section in contrib guide
- Add "PR" abbreviation for those unfamiliar (not used on this
  page but often used elsewhere and when linking to this page)

See QubesOS/qubes-issues#6694
 2021-06-13 21:08:10 -07:00
WillyPillow
a77ff318bd
qvm-template: Update constraints regarding template RPM metadata 2021-06-09 17:25:45 +08:00
WillyPillow
76232f9a1f
qvm-template: Change template-licence to template-license 2021-06-09 17:25:43 +08:00
WillyPillow
8716d23f48
qvm-template: Reflect path changes in qubes-repo-templates 
See 337efb1d3c.
 2021-06-09 17:25:42 +08:00
WillyPillow
2bc69fc466
Tweak slightly for clarity 2021-06-09 17:25:40 +08:00
WillyPillow
2de76980ae
Update info regarding time format 2021-06-09 17:25:38 +08:00
WillyPillow
01110f8253
Fix Google groups link 2021-06-09 17:25:36 +08:00
WillyPillow
96dce2dada
Add indication that qvm-template is not yet merged 2021-06-09 17:25:34 +08:00
WillyPillow
61fb01d673
Move mention of GSoC to Motivations section 2021-06-09 17:25:32 +08:00
WillyPillow
1473712618
Replace with atx headers 2021-06-09 17:25:30 +08:00
Andrew David Wong
a99b53ec11
Remove superfluous "Introduction" heading 2021-06-09 17:25:29 +08:00
WillyPillow
95ee4559ab
Fix incorrect feature name 2021-06-09 17:25:27 +08:00
WillyPillow
dd42704add
Fix link syntax. 2021-06-09 17:25:25 +08:00
WillyPillow
56cf2b768e
Fix whitespace. 2021-06-09 17:25:24 +08:00
WillyPillow
ec37cc6984
Add "Introduction" section. 2021-06-09 17:25:22 +08:00
WillyPillow
3ebde47b23
Replace "template VM" with "TemplateVM". 2021-06-09 17:25:20 +08:00
WillyPillow
54629daa32
Change title to "Template Manager". 2021-06-09 17:25:18 +08:00
WillyPillow
9249f074b3
Fix whitespace. 2021-06-09 17:25:16 +08:00
Andrew David Wong
3b314c84f7
Add YAML header 2021-06-09 17:25:11 +08:00
WillyPillow
44ea629d9f
Include documentation for template manager design 2021-06-09 17:25:02 +08:00
Andrew David Wong
deb33cde69
Copyedit text 2021-05-23 20:36:41 -07:00
Patrick Schleizer
7706060a47
clarify Qubes source code license 
part of https://github.com/QubesOS/qubes-issues/issues/6500
 2021-05-23 13:56:28 -04:00
herypt
90cf4497e4
Fix outdated documentation 2021-05-13 11:54:02 +02: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
Andrew David Wong
593f728ed6
Fix typo 2021-04-17 14:54:26 -07:00
Tobias Killer
190b740e32
Resolve open issues mentioned on Transifex 2021-04-17 10:31:11 +02:00
Tobias Killer
617330d026
Resolve open issues mentioned on Transifex 2021-04-16 19:45:56 +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
Andrew David Wong
b546de3b8d
Merge branch 'md-convention-fullreflinks' of https://github.com/tokideveloper/qubes-doc into tokideveloper-md-convention-fullreflinks 2021-04-09 15:26:52 -07:00
Tobias Killer
7250daea53
Rewrite Markdown convention rule: Do not allow reference links 2021-04-09 09:30:39 +02:00
Andrew David Wong
248673e25e
Update instructions for adding doc index links 
Discussed in QubesOS/qubes-issues#6426
 2021-04-08 06:37:48 -07:00
Tobias Killer
ada42d7023
Add Markdown convention rule about full reference links 2021-04-08 11:25:36 +02:00
Marek Marczykowski-Górecki
16d88ced36
Add ref/lang to GSoD page 
Commit this manually until CI is set for this task
 2021-03-29 06:20:25 +02:00
Marek Marczykowski-Górecki
cbfdf2d7ca
Fix broken links on GSoD page 2021-03-29 02:33:16 +02:00
Marek Marczykowski-Górecki
752f1d4ddc
Fix over indented code blocks 2021-03-28 20:58:39 +02:00
Andrew David Wong
d328b1b1c9
Merge branch 'translation-prepare' of https://github.com/marmarek/qubes-doc into marmarek-translation-prepare 2021-03-26 20:46:10 -07:00
Michael Carbone
9c87e51d9c
fix formatting, remove duplicate past projects 2021-03-25 08:05:05 -04:00
Michael Carbone
84df7767fe
update GSoD page to follow application instructions 
see instructions: https://developers.google.com/season-of-docs/docs/org-proposal-template
 2021-03-25 07:28:11 -04: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
Maya
2bde7d07e0
Rename files to avoid dots in the path 
This is problematic for Transifex API and also ease building
language-specific links.
 2021-03-13 20:11:39 +01:00
Andrew David Wong
b55ef9ee68
Merge branch 'update-gsod' of https://github.com/PROTechThor/qubes-doc into PROTechThor-update-gsod 2021-03-10 21:47:46 -08:00
Marek Marczykowski-Górecki
948525f97a
Add some new projects for GSOC 2021 2021-02-18 02:17:59 +01:00
Marek Marczykowski-Górecki
a240458a8c
GSOC: Remove completed projects, hide in progress ones 2021-02-18 01:37:47 +01:00
Marek Marczykowski-Górecki
b2f5ff7ce5
Merge remote-tracking branch 'origin/pr/1116' 
* origin/pr/1116:
  Updates for GSoC 2021
 2021-02-18 01:34:09 +01:00
E. Cleopatra
b43e72a82c
Updates for GSoC 2021 2021-02-18 00:33:55 +01:00
E. Cleopatra
ff38102071
Update for GSoD 2021, Show past projects 2021-02-17 23:17:18 +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
6e9d015c50
Add info on adding and updating community links in ToC 
QubesOS/qubes-issues#4693
 2020-12-25 08:21:46 -08:00
Robin Schneider
a14070badc
Update URL with 301 permanently moved HTTP status code 2020-12-21 17:38:17 +01:00
Robin Schneider
ec70076361
Use HTTPS everywhere (mechanical edit using util from https-everywhere) 
Ref: https://github.com/EFForg/https-everywhere/tree/master/utils/rewriter

```Shell
~/src/EFForg/https-everywhere/utils/rewriter/rewriter.js .
```
 2020-12-19 19:57:07 +01:00
Andrew David Wong
7610a66873
Update doc guidelines to reflect completed migration 
https://github.com/QubesOS/qubes-issues/issues/4693
 2020-12-07 22:57:40 -08:00
Andrew David Wong
e7568e9808
Update link 2020-12-07 18:40:52 -08:00
Andrew David Wong
c02686c6df
Update guidance regarding relative vs. absolute links 2020-12-07 17:09:34 -08: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
Andrew David Wong
c1f1ee902c
Update image linking syntax; use syntax on same page 2020-12-01 21:37:45 -08:00
Andrew David Wong
d33cd36170
Update examples; fix typo 2020-12-01 21:29:22 -08:00
Andrew David Wong
2c3293ddd1
Add missing link 2020-11-29 12:47:10 -08:00
Andrew David Wong
fa826f6066
Add guidelines on duplication and core vs. external docs 
- Add new "Organizationl guidelines" section
 - Add some relevant links in other sections
 - Update heading syntax to account for new h3s
 - Normalize heading case
 2020-11-29 12:43:48 -08:00
Andrew David Wong
63379e80c6
Remove reference-style link guideline 
Closes #1096
 2020-11-23 10:17:10 -08:00
Andrew David Wong
3df2ffa6f6
Add guideline on syntactically distinguishing variables in commands 2020-11-23 07:08:35 -08:00
Andrew David Wong
17021f6cb7
Update doc guidelines regarding HTML, CSS, and images 2020-11-18 22:26:22 -08:00
Marek Marczykowski-Górecki
d2c9f07bbc
license: drop note about dual-licensing 
This was never enforced (and the way it's written is not enforceable).
So, lets remove dead text.

If we'd like to enforce something like this in the future, we'd need to
require contributors signing CLA. But it wouldn't apply to past
contributions anyway.
 2020-11-13 13:22:35 +01: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
0e5a97785c
Add information about doc review security 2020-10-27 19:23:57 -07:00
Andrew David Wong
e87bb670ee
Add instructions for installing contributed packages 2020-10-19 11:39:51 -07:00
Andrew David Wong
8d6fc28c1a
Merge branch 'patch-3' of https://github.com/dmoerner/qubes-doc into dmoerner-patch-3 2020-10-09 20:39:07 -05:00
Andrew David Wong
9169458de8
Link to build security post 2020-10-09 19:29:43 -05:00
Daniel Moerner
ded05b0260
Update qubes-builder.md 
PyYAML has been renamed to python3-pyyaml in newer versions of Fedora.
 2020-10-03 21:39:32 -04:00
Marek Marczykowski-Górecki
067368ea70
fix formatting 2020-10-04 03:24:06 +02:00
Frédéric Pierret (fepitre)
7a0c466b27
Update qubes-iso-building 2020-09-22 12:36:53 +02: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
Andrew David Wong
9b9d291256
Recommend universal Atx-style headings 2020-08-29 15:42:03 -05:00
Andrew David Wong
0db36137aa
Update arch spec PDF description 
Be even more explicit about its historical nature.
 2020-08-28 11:59:10 -05: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
Andrew David Wong
c58ff2df3d
Note that arch spec PDF is for historical interest 2020-08-07 00:39:03 -05:00
Andrew David Wong
7857970f00
Add Qubes Core Stack section from article; minor improvements 2020-08-03 16:33:21 -05:00
Andrew David Wong
1e6e3ecfa7
Update Qubes architecture diagram 2020-08-03 15:56:11 -05:00
Mostafa Bestawy
9187fed18e
Update gsod.md 
fixing a grammar mistake.
 2020-07-16 23:56:45 +09:00
Mostafa Bestawy
5756ccb2f2
Update gsod.md 
Adding project idea for Installation guide for virtual machines.
 2020-07-15 05:39:37 +09:00
Andrew David Wong
274de93d94
Merge branch 'patch-1' of git://github.com/3hhh/qubes-doc into 3hhh-patch-1 2020-07-12 10:38:54 -05:00
3hhh
aa2e7d74f9
automated-tests: some clarifications 2020-07-12 09:12:36 +02:00
3hhh
83aa08afbd
automated-tests: various fixes 
- add section on how to test inside a VM
- drop content related to Qubes OS 3.2 only
 2020-07-10 12:05:12 +02:00
Frédéric Pierret (fepitre)
da5f688cbd
contrib: add link to example package qubes-skeleton 2020-07-09 18:14:04 +02:00
3hhh
0238a41934
added Admin API Fuzzer idea 2020-06-18 17:14:12 +02:00
Andrew David Wong
8e39f4bc9d
Merge branch 'automated-tests-patch' of https://github.com/deathgrippin/qubes-doc into deathgrippin-automated-tests-patch 2020-06-04 08:14:58 -05:00
null pointer exception
a885447270
Fix typos 2020-06-02 23:39:33 +00:00
null pointer exception
e498e3cdc3
Fix typos 2020-06-02 23:32:55 +00:00
Andrew David Wong
0211516c9e
Fix typos 2020-05-22 05:13:08 -05:00
immeëmosol
e43eb74fd6
add info about domid for pacat-simple-vchan 2020-05-21 19:30:43 +02:00
Andrew David Wong
d0bbce3967
Remove reference to deleted section 2020-05-18 09:29:34 -05:00
Andrew David Wong
39895d552a
Merge branch 'first-patch' of https://github.com/sarru1291/qubes-doc into sarru1291-first-patch 2020-05-14 07:50:13 -05:00
Marek Marczykowski-Górecki
a27bbfc8b2
Remove completed GSoD projects 2020-05-13 14:22:59 +02:00
Sarvottam Kumar
a68bef9933 fix incorrect self-link in gsod.md 2020-05-12 23:57:56 +05:30
Andrew David Wong
a15c7e7f46
Merge branch 'patch-22' of https://github.com/mfc/qubes-doc into mfc-patch-22 2020-04-15 04:55:40 -05:00
Michael Carbone
3e783a4fcc
updated to 2020 GSoD 
removed 2019 project, updated links, added links to 2019 project.
 2020-04-14 10:36:44 -04:00
Michael Carbone
696f507fc3
update link to 2020 GSoC Qubes page 2020-04-14 09:58:40 -04:00
Andrew David Wong
9c3d182a77
Merge branch 'cursor' of https://github.com/pwmarcz/qubes-doc into pwmarcz-cursor 2020-03-31 14:56:36 -05:00
Paweł Marczewski
cc4a4cbf90
admin-api: fix table glitch 
The `|` needs to be escaped.
 2020-03-30 15:48:07 +02:00
Paweł Marczewski
9e97e03d14
Document MSG_CURSOR 
See QubesOS/qubes-issues#1551.
 2020-03-30 15:02:26 +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
unman
4783f2a989
Qubes-builder - update template versions 2020-02-23 00:36:50 +00:00
unman
5fcf8ce484
Source Code - update instructions on downloading repositories 2020-02-20 16:05:11 +00:00
Andrew David Wong
c168714039
Merge branch 'internals' of https://github.com/pwmarcz/qubes-doc into pwmarcz-internals 2020-02-17 04:20:50 -06:00
Marek Marczykowski-Górecki
c254b11a85
GSoC: link one more issue to template manager idea 2020-02-16 21:00:23 +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
Marta Marczykowska-Górecka
6ced25e79b
Updates for GSC 2020 
Commented out various obsolete projects, removed one that is genuinely done.
 2020-01-30 22:59:42 +01:00
Andrew David Wong
231464a19c
Merge branch 'vmexec' of https://github.com/pwmarcz/qubes-doc into pwmarcz-vmexec 2020-01-26 08:07:23 -06:00
Pawel Marczewski
6563038796
Document qubes.VMExec call 
See QubesOS/qubes-issues#4850.
 2020-01-24 19:06:20 +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
Andrew David Wong
939995eda9
Merge branch 'patch-5' of https://github.com/mfp20/qubes-doc into mfp20-patch-5 2020-01-19 16:34:39 -06:00
mfp20
3bbf7b91ce
Adds "Notes" chapter 
Can be used to include misc notes.
 2020-01-16 19:17:04 +01:00
mfp20
272a24843f
Create "Further information" chapter. 
And move the lines from the top to this chapter.
In order to give a hook for advanced use and have it in the left side contents menu for easy access.
 2020-01-16 18:53:12 +01:00
Elliot Killick
0303f6017d
Fix typos 
Format `new` does not exist. Probably meant `newc` as also used later.

Missed a `$` for variable.
 2020-01-01 19:16:27 +00: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
pierwill
c967c7b145
Edit qrexec doc page titles 2019-12-05 21:46:49 -08:00