Commit Graph

1001 Commits

Author SHA1 Message Date
Dr. Gerhard Weck
c86d57e44b
Add explanation for firewall rule in target VM
Is it really the firewall address in the rule of the target VM? Or, instead, the originating address of the web access?
2022-05-13 13:25:54 +02:00
Andrew David Wong
cace95742e
Merge branch 'master' of github.com:AlxHnr/qubes-doc into AlxHnr-master 2022-05-11 03:51:10 -07:00
Dr. Gerhard Weck
1a02c6a909
Clarify use of IP addresses for frowarding 2022-05-08 13:13:31 +02:00
Alexander Heinrich
92411d8454
Update user/troubleshooting/installation-troubleshooting.md
Co-authored-by: Demi Marie Obenour <demiobenour@gmail.com>
2022-05-06 18:52:58 +02:00
deeplow
bcb7231aac
make consistent with UI
Ideally the UI would already show app qube, but it doesn't (yet).
2022-05-02 11:58:08 -04:00
Andrew David Wong
d5748de0ba
Add warning about updating software from other sources 2022-04-20 14:51:39 -07:00
Andrew David Wong
33b73af4ae
Improve formatting and style consistency; add reminder; fix typo 2022-04-20 14:37:28 -07:00
Andrew David Wong
ca5b730194
Update "how to install software"
- Add section on installing software from non-default-repo sources
- Remove deprecated content
- Improve organization

Thanks to Insurgo, Sven, and all the other participants in this forum
thread: https://forum.qubes-os.org/t/10935/
2022-04-20 14:19:04 -07:00
ygrek
db57bfff50
fix qubes-prefs command 2022-04-02 16:32:13 -04:00
Dr. Gerhard Weck
6360d20ae9
Add instructions for Windows under Qubes R4.1
Separate texts for Qubes R4.0 and R4.1
2022-03-26 15:54:32 +01:00
Andrew David Wong
9ea4a8a7eb
Fix numbering again 2022-03-16 00:53:43 -07:00
Andrew David Wong
3a7f66a6d6
Fix typo 2022-03-16 00:52:05 -07:00
Andrew David Wong
28301889f7
Fix stage numbering; copyedit
See: https://forum.qubes-os.org/t/10156
2022-03-16 00:50:08 -07:00
deeplow
1cb8811a1b
fix name
According to @marmarek's comment in https://github.com/QubesOS/qubes-issues/issues/6507#issuecomment-1067135102
2022-03-14 14:43:42 -04:00
chiu410
82b1d8e789
Update yubi-key.md 2022-03-14 02:07:35 +08:00
Alexander Heinrich
3ef5cdd374 Update troubleshooting guide: "Unsupported Hardware Detected" 2022-03-12 20:58:32 +01:00
Andrew David Wong
5b29e903d2
Address common misunderstanding about updates proxy 2022-03-07 16:50:22 -08:00
Andrew David Wong
1986a5e372
Copyedit text 2022-03-07 16:40:16 -08:00
Andrew David Wong
2c89410c1d
Fix typo 2022-03-07 16:35:00 -08:00
Andrew David Wong
21ab2713da
Explain software installation situation and link to deeplow's guide (#1236) 2022-03-07 16:31:42 -08:00
deeplow
704d687316
Add link to community guide 2022-03-07 08:37:24 +00:00
Andrew David Wong
1c8f2bf981
Use relative link; copyedit text 2022-03-06 15:55:36 -08:00
Ivan
989797c3fa
add link to 2020 article for new 4.1 policy 2022-03-02 18:40:33 +00:00
Andrew David Wong
d5d62dea18
Fix anchor link 2022-03-02 09:24:48 -08:00
Andrew David Wong
952cdd859a
Link to post about novice users and minimal templates
Per fsflover's suggestion: https://forum.qubes-os.org/t/9717/18
2022-03-01 07:12:07 -08:00
Andrew David Wong
2fbb6c574a
Merge branch 'usb-update' 2022-02-20 07:17:48 -08:00
Andrew David Wong
d35a602bb7
Fix errors; label release-specific content 2022-02-20 07:15:21 -08:00
Andrew David Wong
a4aea3e981
Add warnings and mitigation for QubesOS/qubes-issues#6585
See the discussion on QubesOS/qubes-posts#79.
2022-02-19 15:17:13 -08:00
gezet007
1c1c6c1952
## Backing up changes to dom0
I assume the last line in:

$ mkdir -p ~/backup/etc/qubes/
$ cp -a /etc/qubes/* ~/backup/etc/qubes/
$ mkdir ~/backup/etc/qubes-rpc/
$ cp -a /etc/qubes-rpc/* ~/systemfiles/etc/qubes-rpc/

should instead read:

$ mkdir -p ~/backup/etc/qubes/
$ cp -a /etc/qubes/* ~/backup/etc/qubes/
$ mkdir ~/backup/etc/qubes-rpc/
$ cp -a /etc/qubes-rpc/* ~/backup/etc/qubes-rpc/
2022-02-18 14:29:00 +01:00
Andrew David Wong
dacd90704f
Merge branch 'read-pass' of github.com:rustybird/qubes-doc into rustybird-read-pass 2022-02-10 18:40:31 -08:00
Andrew David Wong
f7948c4b53
Remove 404 link to nonexistent page
As far as I can tell, this page never existed.
2022-02-10 18:38:25 -08:00
Andrew David Wong
f5f898f65f
Merge branch 'patch-1' of github.com:SaswatPadhi/qubes-doc into SaswatPadhi-patch-1 2022-02-10 18:34:20 -08:00
Andrew David Wong
e65a1d6987
Revise text (#1193) 2022-02-07 01:52:35 -08:00
Andrew David Wong
739fa1a7ef
Merge branch 'patch-1' of github.com:ninavizz/qubes-doc into ninavizz-patch-1 2022-02-07 01:47:10 -08:00
Andrew David Wong
cc23f09c4c
Merge branch 'guivm' of github.com:fepitre/qubes-doc into fepitre-guivm 2022-02-07 01:29:57 -08:00
Andrew David Wong
57157e657d
Update "supported releases" with 4.1 release data 2022-02-04 14:47:44 -08:00
Andrew David Wong
be5511a6af
Update links 2022-01-24 15:21:36 -08:00
Andrew David Wong
80d5a6f7c6
Revamp "USB qubes" page; update links 2022-01-24 14:43:22 -08:00
Marek Marczykowski-Górecki
9e414119e7
USB: document improved USB HID handling on Qubes 4.1
1. Describe setup with separate USB controller.
2. Add info about built-in USBGuard support.
2022-01-20 05:16:25 +01:00
Marek Marczykowski-Górecki
ac9e74a530
USB: add info about GRUB2 on Qubes 4.1 with EFI too 2022-01-20 05:15:30 +01:00
Rusty Bird
51398a74be
Port v4 emergency restore password handling to v2 and v3
Fixes QubesOS/qubes-issues#1967
2022-01-02 13:18:56 +00:00
Rusty Bird
cf460ca6a5
Query passwords with 'read -r'
'read' without '-r' interprets escape sequences, so it may not behave
properly if the password contains literal backslashes (depending on the
next character).
2022-01-02 13:05:47 +00:00
Frédéric Pierret (fepitre)
777e1bccbb
guivm: use relative links 2021-12-26 22:34:28 +01:00
Andrew David Wong
b9c6de6f87
Merge branch 'patch-1' of github.com:smoothie-on-the-rocks/qubes-doc into smoothie-on-the-rocks-patch-1 2021-12-22 01:41:59 -08:00
smoothie-on-the-rocks
50488bfc05
Change inline commands to block for easy selection
This slight change in format allow to select the command by triple clicking it. Currently, it selects the whole line. Also, when viewed from github, the block can be copied by clicking in the link on the right side.
2021-12-10 17:56:08 +00:00
smoothie-on-the-rocks
e724e60c9e
Add fedora details to convert VM to Qube section 2021-12-10 12:05:32 +00:00
Andrew David Wong
d24bffe85d
Merge branch '6911' of github.com:unman/qubes-doc into unman-6911 2021-12-07 12:35:28 -08:00
Andrew David Wong
0f1440c976
Add Debian 11 support for Qubes 4.0
QubesOS/qubes-issues#6865
2021-12-07 09:29:01 -08:00
unman
3fc612d6be
Update qvm-prefs output to 4.0 format 2021-12-05 01:23:41 +00:00
tt-why
dce008bc27 Update U2F proxy doc when having non standard sys-usb qubes name 2021-11-30 14:28:03 +00:00
Andrew David Wong
c0376565ed
Remove Fedora 33 from supported templates (EOL) 2021-11-30 04:03:16 -08:00
Michael Vermaes
7df6ec9c03
Trivial typo - remove extraneous bracket 2021-11-18 11:01:14 +08:00
Andrew David Wong
613e3e63e5
Merge branch 'min-net' 2021-11-16 16:29:25 -08:00
unman
924511184f
State requirement for networking from minimal templates. 2021-11-16 15:44:42 +00:00
unman
361534f764
Review template use before trying to remove 2021-11-16 15:15:31 +00:00
Andrew David Wong
20ec1303f1
Remove Whonix 15 support (EOL) 2021-11-14 14:27:53 -08:00
Ark-of-the-copepod
be09220d33
wrong package name, line 237
For Debian, `ncat` works not `nmap-ncat`.
2021-11-13 05:38:39 +00:00
Andrew David Wong
31427197c9
Add F34 template support to 4.0
QubesOS/qubes-issues#6568
2021-11-12 05:38:12 -08:00
Malte
9f1c4aa79a
shortcut configuration via qvm-features instead of guid.conf
With Qubes 4.1 coming out soon, maybe it's a good time to tell people how to get their shortcuts working again?
2021-10-12 20:38:19 +02:00
Andrew David Wong
f380742b08
Update supported 4.1 templates 2021-10-11 17:14:19 -07:00
Andrew David Wong
5134fe46da
Add and update links; wrap text 2021-10-11 16:20:24 -07:00
Marek Marczykowski-Górecki
f5ca579fe0
Fill in R4.0->R4.1 upgrade steps 2021-10-10 06:50:12 +02:00
Andrew David Wong
e904cc0d68
Create initial 4.1 upgrade page 2021-10-09 09:17:52 -07:00
Andrew David Wong
21798686fa
Improve organization of upgrade guides 2021-10-09 08:52:24 -07:00
deeplow
37bf829ee4
fix md typo 2021-10-04 06:30:58 -04:00
Andrew David Wong
2b0871f406
Add Whonix 16 support; clarify that upstream EOL supersedes table 2021-09-30 22:10:25 -07:00
Andrew David Wong
90ac679fab
Improve languge, syntax, and formatting; add link; wrap text 2021-09-26 16:47:15 -07:00
Sven Semmler
5d6ba66b6e
Changed security archive layout for bullseye
I submitted #1191 previously but then had already purged my local fork. So I was unable to change it (if there is a way I am oblivious to it). Hence I closed #1191 and opened this pull request in it's place. Sorry for that.
2021-09-15 15:22:03 -05:00
3hhh
6cfc10bb91
Update device-handling-security.md
minor clarifications
2021-09-13 11:40:33 +02:00
Andrew David Wong
e8c1025335
Fix link 2021-09-13 02:05:27 -07:00
Andrew David Wong
7f881d8df9
Change "netvm" to "net qube"
QubesOS/qubes-issues#1015
2021-09-07 23:17:30 -07:00
Nina Eleanor Alter
d9bb0edf8c
Update how-to-update.md
Updated per Demi's clarification that only dom0 updates do the update-vm/terminal-window-open stuff.
2021-09-07 14:11:35 -07:00
Nina Eleanor Alter
231d349d19
Update how-to-update.md
Per Andrew's comment, made updates. I did not want to follow the styleguide 1:1, literally—as a user viewing mostly redundant text is more likely to visually recognize the redundancy and skip past it, without making the effort to see deviations.
2021-09-07 12:50:25 -07:00
Nina Eleanor Alter
fca16e7f7f
Update how-to-update.md
Per https://github.com/QubesOS/qubes-issues/issues/#6871 added a blurb in the CLI section, to advise users that 1. The terminal in the update-vm will in fact open, and 2. Where the logs will be saved to. My notation on two may be incorrect, so pls check?
2021-09-07 12:28:29 -07:00
Andrew David Wong
0257a3f44a
Update "Certified hardware"
- Add requirement that certified devices must be available for purchase
  with Qubes OS preinstalled. See: https://forum.qubes-os.org/t/5795/
- Improve wording
- Add link to HCL in intro
- Wrap text
2021-09-06 14:07:20 -07:00
Andrew David Wong
9437476c77
Rename file to match new contents
See previous commit message. File rename is in this separate commit to
maintain file history in Git.
2021-09-03 22:04:19 -07:00
Andrew David Wong
cf8fe618fa
Deprecate "Hardware testing" page
Convert it into a redirect to the community-recommended hardware list on
the Qubes Forum. File rename will be in subsequent commit to maintain
history. See:
https://forum.qubes-os.org/t/short-list-of-laptops-desktops-that-work-well-with-qubes-os/5197/159?u=adw
2021-09-03 22:03:10 -07:00
Saswat Padhi
f4c00061dd
Update managing-vm-kernels.md
Added GRUB installation steps:
- `grub2-install` on Fedora
- `grub-install` on Debian
2021-08-15 20:30:11 +00:00
Andrew David Wong
d75a0dcfe2
Genericize anchor text and shorten URL (#1187)
Mitigates against future changes in thread title.
2021-08-08 02:34:43 -07:00
Andrew David Wong
0ca6239915
Remove release number from URLs (#1187)
This won't break the URLs. They'll just automatically redirect to the
correct thread. This will allow us to keep updating and re-using the
same thread and URL without scaring off users who see "r4-0-4" in the
URL and think it's out-of-date in the future.
2021-08-07 05:14:09 -07:00
Andrew David Wong
6446acdad8
Update hardware-related docs
- Add links to "just works" list
- Improve organization
- Standardize orthography
- Wrap text
- Remove very old ML link
- Minor wording improvements
2021-08-07 04:36:28 -07:00
Sven Semmler
725800ead5
Add "Just works" for R4.0.4 and the CPU info
Link to the forum post with the community created "just works" list for R4.0.4; also added the respective CPU info the the testing hardware retrieved from @marmarek
2021-08-06 17:21:17 -05:00
Frédéric Pierret (fepitre)
4b0ced18d7
GuiVM: fix typo in a note
From @tlaurion's suggestion
2021-07-29 21:40:30 +02:00
Frédéric Pierret (fepitre)
bb84bcef90
GuiVM: second pass on documentation
Add @marmarek's suggestions
2021-07-29 15:57:41 +02:00
Frédéric Pierret (fepitre)
e07224dec7
GuiVM: add documentation 2021-07-29 15:57:30 +02:00
Andrew David Wong
717810fb11
Document 'zenity' requirement for GUI inter-qube copying
Fixes QubesOS/qubes-issues#6801
2021-07-28 22:53:15 -07:00
Andrew David Wong
322fe6ca9f
Add sentence about joining the testing team
https://forum.qubes-os.org/t/testing-team-how-to-deal-with-in-forum/4453/49?u=adw
2021-07-26 07:16:25 -07:00
deeplow
f88cd02cc6
fix typo 2021-07-26 08:17:47 -04:00
deeplow
23d027deae
add extra case for installation freezing
If installing in external SSD sometimes and when the user forgets to disable sys-usb the initial setup also
fails after setup networking.
2021-07-25 11:57:30 +00:00
Andrew David Wong
6fe0e40fb3
Merge branch 'fix20210614' of https://github.com/zpc0/qubes-doc into zpc0-fix20210614 2021-07-20 06:01:26 -07:00
Yanase Yuki
71ae00b56f
Use docs.saltproject.io for SaltStack document
Official SaltStack repository now uses saltproject.io, so use
new domain name to avoid unnecessary redirects.

example:
https://github.com/saltstack/salt/commit/dfa0619b9e55058b
2021-07-20 19:33:09 +09:00
Yanase Yuki
8a0ba67406
Fix SaltStack document links 2021-07-20 19:32:37 +09:00
Andrew David Wong
54525b2e09
Update links; fix typo 2021-07-20 03:27:51 -07:00
Dave Smith
d01ad9c33e
Fix htmlproofer errors in PRs #1176 & #1177...
caused by hcl.md file rename in qubes-doc commit 7d894a59.
2021-07-16 01:15:15 -05:00
Andrew David Wong
db56549748
Move files back to qubes-doc so they can appear in index
I'm still not sure why these files have to be in qubes-doc in order to
appear in the doc index, but they do, so I'm moving them back even
though they're mostly empty.
2021-07-14 11:20:16 -07:00
Andrew David Wong
7d894a5971
Update filename to match new title 2021-07-14 11:16:34 -07:00
Andrew David Wong
c001d2136b
Update title to distinguish from main HCL page
Moving redirects to main HCL page in a separate commit.
2021-07-14 11:15:29 -07:00
Andrew David Wong
4ff7399334
Copyedit 2021-07-13 15:28:42 -07:00
Dave Smith
13f799725f
Fix link to HTML syntax (#1174) 2021-07-12 08:09:26 -05:00
Dave Smith
4055787313
Add clarification based on PR #1174 feedback 2021-07-11 22:38:26 -05:00
Dave Smith
d4d00ef9d1 Tag for commit 6eea2bf394
-----BEGIN PGP SIGNATURE-----
 
 iQIzBAABCgAdFiEE4R0VxtIENXaf+qRWjOE3NSoBmhcFAmDqGVAACgkQjOE3NSoB
 mhcsdg/6A2zT+GvdR0XtnGxyJoI1WDTHrTSt9e0BiVOWorCs1OoL85leR0jvzWgO
 hcXeIxiQK7EnG/QKQC1UMY3gSfL+t8bkaGlXVqcNPFdbVIiHqg/w0KuMaA1pq4mQ
 slGtcZyQjjWLLm8RiL4KxshnqVZWqokQwOg3GwL72bNvVxOGb5nJAI9VIyq9+C6N
 rqE3qUg3CkzVUxjEFh8kNjGGc/SrpWRlXDHr/6+L5BgGKGcXjhy3S480yRNHU5LI
 V/xqkFa+QJaA5F0E+2CIX+fuHSQGl8HrupdXltBRT4VYTibLICGAPsiibpETSrNX
 f0lPXUfJAQINw9MAWEvypuFhCHc21xwV/KHVymGuUsbLVFsSUDFrAimb9zBxvqRC
 MNAnIBcwrvgxBBg2P4XVTLaV6fKe8vGf3fuiV0Rlxpjk/5oq8KKwCc9LeSd1Q+Sq
 hHV72j/yOpXe/FJ10eWMJQLoOGUk/aMu8gAhpjSMBzuDV9kmwp3H2eNNrTrU3hxW
 UAvSaNTCK+klmNTWfiPKDaQCtJFhrBqglzo/yNo0JUBhpP6azZ41ISU9pd9lamc5
 kbBWioRjeb6hQ+aBgU6W2UY+q9S6gyvITpfB+PmjU+HzCUqoxpKKe2epQnnm63Tn
 46eceH/DdlFWZcRP0Zi2aMsdyylwRaGVoRASwb90JKRtfVSEd58=
 =gYJ6
 -----END PGP SIGNATURE-----
gpgsig -----BEGIN PGP SIGNATURE-----
 
 iQGzBAABCAAdFiEE2igx/unaOtbQrvi8nUlmN9gUhKYFAmDrOeAACgkQnUlmN9gU
 hKYoCwv/RQXtJxSkEz79FaVQHFb2Jw2MK5Gl1W6mjDbOSHvyPJEHH04ZzQnIQKZX
 cYGSTvXoSiqdLwlFi+vGZXqdWPYprOCjDKDz0E+0Mxh4gr6FKY9NNlq335wN1ePg
 AEoHI78OzRHhyUBVJuEpS6MAHl45xkxbC6wsBvx+23/rSit5aNopghtiE7Ln/RlO
 fxfUUrYbA3sMr8TvxSiMSr6KkjFWZU44s5Gu+PH/N/iTmbYbSXmCvMP6j9V1BwKq
 2JDyGXIdqpGztAojiWDNL+b7lV0+Bd1QXh3BnBJ6H9u3TpqNC0nihPeATlV0SJi8
 dG1AB87/dv6NiZo4v5MH+yYIHyYNhte8vvPeN3NqoMHr4M9t3p9SviJc9+sVFDwZ
 X0eBx1aaZT7PDex2EPX9eHIVgBkzuhuMab9l5+zXDril+g/KOGPHwmk11PeEb3mA
 FNuo6HKwxuD0zVzPN0vQmcHG1nIl612sugI9J0bp6ZmaFdlApKa6UP57jE0I8Qg0
 Jz8IC2qg
 =hQrV
 -----END PGP SIGNATURE-----

Merge tag 'adw_6eea2bf3'

Tag for commit 6eea2bf394

# -----BEGIN PGP SIGNATURE-----
#
# iQIzBAABCgAdFiEE4R0VxtIENXaf+qRWjOE3NSoBmhcFAmDqGVAACgkQjOE3NSoB
# mhcsdg/6A2zT+GvdR0XtnGxyJoI1WDTHrTSt9e0BiVOWorCs1OoL85leR0jvzWgO
# hcXeIxiQK7EnG/QKQC1UMY3gSfL+t8bkaGlXVqcNPFdbVIiHqg/w0KuMaA1pq4mQ
# slGtcZyQjjWLLm8RiL4KxshnqVZWqokQwOg3GwL72bNvVxOGb5nJAI9VIyq9+C6N
# rqE3qUg3CkzVUxjEFh8kNjGGc/SrpWRlXDHr/6+L5BgGKGcXjhy3S480yRNHU5LI
# V/xqkFa+QJaA5F0E+2CIX+fuHSQGl8HrupdXltBRT4VYTibLICGAPsiibpETSrNX
# f0lPXUfJAQINw9MAWEvypuFhCHc21xwV/KHVymGuUsbLVFsSUDFrAimb9zBxvqRC
# MNAnIBcwrvgxBBg2P4XVTLaV6fKe8vGf3fuiV0Rlxpjk/5oq8KKwCc9LeSd1Q+Sq
# hHV72j/yOpXe/FJ10eWMJQLoOGUk/aMu8gAhpjSMBzuDV9kmwp3H2eNNrTrU3hxW
# UAvSaNTCK+klmNTWfiPKDaQCtJFhrBqglzo/yNo0JUBhpP6azZ41ISU9pd9lamc5
# kbBWioRjeb6hQ+aBgU6W2UY+q9S6gyvITpfB+PmjU+HzCUqoxpKKe2epQnnm63Tn
# 46eceH/DdlFWZcRP0Zi2aMsdyylwRaGVoRASwb90JKRtfVSEd58=
# =gYJ6
# -----END PGP SIGNATURE-----
# gpg: Signature made 7/10/2021 5:04:00 PM Central Daylight Time
# gpg:                using RSA key E11D15C6D20435769FFAA4568CE137352A019A17
# gpg: Can't check signature: No public key
2021-07-11 13:35:12 -05:00
Dave Smith
cc8155ff9f
Undo change to 'Copying the ISO' header, not worth the broken links 2021-07-11 13:30:32 -05:00
Andrew David Wong
65f032a45c
Update patch release description for accuracy 2021-07-10 14:42:17 -07:00
Andrew David Wong
26b1a4d6db
Change "point relase" to "patch release" for precision
In general, the software world is not clear about these terms. However,
the most common usage seems to use "point release" to refer to any
release with at least one period in the version number, which would also
include minor releases. By contrast, "patch release," though a much less
common phrase, unambiguously denotes a release with a version number
containing two periods.

See:
https://en.wikipedia.org/wiki/Point_release
https://semver.org/
2021-07-10 14:29:48 -07:00
Andrew David Wong
ca0ccab949
Update titles and links 2021-07-10 14:25:29 -07:00
Andrew David Wong
039f2f87b9
Update filename 2021-07-10 13:52:46 -07:00
Andrew David Wong
7ecbf8f530
Change "version" to "release"
See https://github.com/QubesOS/qubes-issues/issues/5308#issuecomment-877700342
2021-07-10 13:50:26 -07:00
Andrew David Wong
3f0977be1b
Fix typo; improve image titles (#1172) 2021-07-10 12:39:28 -07:00
Andrew David Wong
380e7b43b9
Fix and improve installation guide (#1172)
- Improve language
- Fix image links
- Explain BIOS and UEFI, provide links
- Fill in missing steps and information gaps
- Standardize grammar and punctuation
- Improve formatting
- Clarify instructions and explanations
2021-07-10 12:22:46 -07:00
Andrew David Wong
0309e79ca8
Merge branch 'patch-23' of https://github.com/deeplow/qubes-doc into deeplow-patch-23 2021-07-10 11:33:47 -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
c29cf40910
Reorganize doc guidelines into multiple pages; update style guide
The existing doc guidelines page attempts to combine too many different
topics at once and includes information that does not pertain directly
to the documentation. This reorganization is intended to make each type
of information easier to find. For example, some have found it difficult
to find the documentation style guidelines (see, e.g.,
QubesOS/qubes-issues#6701#issuecomment-875875610). This reorganization
allows us to assign more specific titles to each page.

General changes:
- Create new page for contribution instructions
- Create new page for website style guide
- Create new page for continuous integration
- Rename existing "style guide" to "visual style guide" in order to
  avoid ambiguity with new doc and website style guides
- Retain existing page solely for doc style guide
- Update page names and permalinks
- Update existing links
- Improve language

Doc style guide changes:
- Add section on using sentence case in headings
  (see QubesOS/qubes-issues#6756 and #1173)
- Improve section organization
- Clarify language

In order to better preserve the Git history of each file, file renames
will be handled in a separate commit.
2021-07-08 08:08:57 -07:00
Dave Smith
64b1015e17
Reduce Windows confusion in renamed 'Installation medium preparation' section 2021-07-07 22:12:46 -05:00
deeplow
f4e726c818
minor changes 2021-07-06 20:33:54 +00:00
deeplow
9d2bc4341f
Replace all BIOS mentions with BIOS/UEFI 2021-07-06 20:27:05 +00:00
deeplow
a448289442
remove duplicated information about boot device 2021-07-06 20:18:03 +00:00
deeplow
b3d9e00bae
Update installation-guide.md 2021-07-06 20:01:55 +00:00
gw0
ad6bcf7fb4 Update resume-suspend-troubleshooting.md 2021-07-06 13:19:15 +02:00
Andrew David Wong
9d390bdb0d
Use Markdown syntax instead of HTML
Although the HTML tags are technically correct, it's probably more
important to preserve source readability and avoid the problems that
HTML-in-Markdown poses for localization and offline documentation.
2021-07-06 02:06:50 -07:00
deeplow
9e0de52023
add info on boot menu (part 1) 2021-07-05 18:41:06 +00:00
Andrew David Wong
0b5e3005c2
Document template testing; improve related docs
- Document template testing repos
- Introduce dom0 testing repos
- Cross-link dom0 and domU testing repo sections
- Link to template testing section from related sections
- Add pointer to installing templates
- Minor improvements and fixes

Thanks to @GWeck for pointing out the need for this in:
https://forum.qubes-os.org/t/fedora-34-template-available-for-testing/4904/4
2021-07-05 06:09:42 -07:00
Andrew David Wong
41ed804361
Wrap text; improve wording 2021-07-05 05:35:57 -07:00
Andrew David Wong
440ca6a597
Update Whonix links; add Privacy Policy links 2021-07-05 05:26:21 -07:00
Andrew David Wong
bae794951d
Capitalize second word in title case compound adjectives
https://github.com/QubesOS/qubes-issues/issues/6756#issuecomment-873385039
2021-07-04 03:35:59 -07: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
Andrew David Wong
86cdf83aed
Merge branch 'patch-2' of https://github.com/ninavizz/qubes-doc into ninavizz-patch-2 2021-07-03 04:19:16 -07:00
Andrew David Wong
3806744ce0
Fix capitalization
https://github.com/QubesOS/qubes-doc/pull/1169/files#r663353238
2021-07-03 04:18:32 -07:00
Andrew David Wong
5220089b53
Update references to "Getting Started"
QubesOS/qubes-issues#6756
2021-07-03 03:46:27 -07:00
Andrew David Wong
ca109b05c7
Change name back to "Getting Started" and move to intro
QubesOS/qubes-issues#6756
2021-07-03 03:40:13 -07:00
Nina Eleanor Alter
dc0433edcd
Update how-to-use-block-storage-devices.md
Remove use of the phrase "GUI" and specifically speak to the "Devices WIdget." Especially since it is now referenced in the Getting Started section, which should cross-link, here.
2021-07-02 14:58:59 -07:00
Andrew David Wong
baa1df911c
Update Qubes Forum URLs 2021-07-01 07:03:05 -07:00
Andrew David Wong
d9b061f8f7
Copyedit 2021-06-26 06:24:32 -07:00
Andrew David Wong
871d281320
Update title and permalink to match filename 2021-06-26 06:10:49 -07:00
Andrew David Wong
10cdaf3cdf
Fix filename to conform to section naming scheme 2021-06-26 06:09:15 -07:00
Andrew David Wong
0c699de048
Merge branch 'skip-autostart' of https://github.com/fepitre/qubes-doc into fepitre-skip-autostart 2021-06-26 06:06:01 -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
1d40a958c2
Sort frontmatter entries
Again, this makes scripted modifications easier.
2021-06-24 16:10:26 +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
Frédéric Pierret (fepitre)
bccc64d480
skip-autostart: precise supported releases and modes 2021-06-23 18:46:20 +02:00
Frédéric Pierret (fepitre)
069c805d04
troubleshooting: add qubes.skip_autostart
Related QubesOS/qubes-issues#4312
2021-06-23 16:28:03 +02:00
Andrew David Wong
3b700bfa63
Update "Standalones and HVMs"
- Add and update links
- Update terminology
- Fix and improve syntax
- Clarify command-line variables
- Fix headings
- Improve language
- Make syntax consistent
- Remove deprecated and inaccurate information
- Improve grammar and orthography
- Fix typos
- Wrap text

Related to #1164
2021-06-23 01:48:00 -07:00
deeplow
3b4c9bf434
Make replaceable text like <THIS> instead of <this> 2021-06-23 07:55:18 +00:00
Andrew David Wong
d145143261
Update Qubes Canary page link 2021-06-22 10:55:21 -07:00
Andrew David Wong
6cc2f9932b
Update QSB page link 2021-06-22 10:50:12 -07:00
Andrew David Wong
6fa8777f37
Clarify and simplify language 2021-06-22 06:56:10 -07:00
Andrew David Wong
c2397776ac
Merge branch 'patch-1' of https://github.com/ninavizz/qubes-doc into ninavizz-patch-1 2021-06-22 06:47:22 -07:00
Andrew David Wong
f97eaa7b94
Move HCL listing page to main repo
This file contains no significant content.
2021-06-22 01:26:38 -07:00
Andrew David Wong
a015f60087
Fix links 2021-06-21 18:39:21 -07:00
Nina Eleanor Alter
6547239de9
Update how-to-get-started.md
- Added line-item for "Clipboard" widget in 'Unique Items' area
- Re-ordered bulleted items to follow L-R ordering of items in image
2021-06-21 15:42:50 -07:00
Andrew David Wong
1e7a76ffa7
Fix capitalization 2021-06-21 04:12:33 -07:00
Andrew David Wong
74a547ae14
Update "How to Use Disposables"
- Restore old redirect
- Add glossary links
- Update terms
- Fix capitalization
2021-06-21 04:06:25 -07:00
Andrew David Wong
527a2eb339
Update links 2021-06-21 00:38:18 -07:00
Andrew David Wong
58200e52ce
Add glossary links; improve wording 2021-06-20 22:50:30 -07:00
Andrew David Wong
7d30b685bf
Update title for accuracy 2021-06-20 22:49:41 -07:00
Andrew David Wong
d31155a89e
Add entry for "management qube" 2021-06-20 22:49:09 -07:00
Andrew David Wong
435f2f655e
Update "How to Update"
- Create new "Command-line interface" section
- Move warning about direct commands to new section
- Move info about qubesctl commands and testing repos to new section
- Revise "Upgrading" section
2021-06-20 22:27:43 -07:00
Andrew David Wong
7c83d84381
Fix link; add section on installing software 2021-06-20 22:01:01 -07:00
Andrew David Wong
3b0c0be9be
Steer newbies toward easy upgrade method even more 2021-06-20 21:55:36 -07:00
Andrew David Wong
bc138e0dc4
Update links 2021-06-20 21:54:36 -07:00
Andrew David Wong
87948a3d0d
Update URL to match title 2021-06-20 20:55:57 -07:00
Andrew David Wong
92016a6ba1
Update "How to Install Software"
- Improve intro
- Make key instruction steps harder to miss
- Add "Troubleshooting" section
- Move text on updating standalones to "Standalones and HVMs"
2021-06-20 20:43:43 -07:00
Andrew David Wong
dffa3502fd
Update "Templates"
- Add links
- Improve formatting
- Improve command examples
- Add related information
- Improve language
- Improve inheritance and persistence table
- Update terminology
- Wrap text
2021-06-20 20:03:48 -07:00
Andrew David Wong
09ba96bbd6
Rename "awesome" to "AwesomeWM"; update image, links
Based on examining the AwesomeWM project's web presences and Wikipedia
entry, there does not appear to be a single consistent name by which the
project refers to its window manager. All three of these variations are
used: "awesome", "Awesome", and "AwesomeWM". In order to avoid ambiguity
with the regular English word, we're opting for "AwesomeWM" in our own
documentation.

This commit also reverts the change to the widget image, since that
change was not necessary (see #1161).

Finally, this commit adds links to the KDE, i3, and AwesomeWM pages.
2021-06-20 19:04:09 -07:00
Andrew David Wong
0b95303b3c
Merge branch 'patch-1' of https://github.com/ninavizz/qubes-doc into ninavizz-patch-1 2021-06-20 18:46:46 -07:00
Andrew David Wong
61c38685ef
Add trailing slash 2021-06-20 18:27:31 -07:00
noskb
1e469ea089
Fix redirect to 404 from /doc/disposablevm
The link appears on the first page of a search result for "qubes disposable", but it is not redirecting correctly.
2021-06-21 00:38:18 +00:00
Nina Eleanor Alter
3cca147caa
Update how-to-get-started.md
- Updated image to match wording to names shown above
- Edited "custom" to "unique" wrt "unique to qubes," as sdwdate is not custom _to_ qubes, but is unique(ish) to Qubes.
- Included bullet for Whonix widget, w/ link-out
- Capitalized "A" on Awesome in desktop environments
2021-06-20 15:47:56 -07:00
Andrew David Wong
6a88601739
Update "Testing New Releases and Updates"
- Convert alert into text warning
  (Now that every advanced page has the same sticky alert at the top,
  it looks odd to have similar alerts above and below the h1 heading.)
- Update heading syntax
- Wrap text
2021-06-19 21:06:40 -07:00
Andrew David Wong
f490482273
Update "How to Install Software in Dom0"
- Convert alert into text warning
  (Now that every advanced page has the same sticky alert at the top,
  it looks odd to have similar alerts above and below the h1 heading.)
- Fix headings
- Fix syntax
- Wrap text
2021-06-19 21:01:26 -07:00
Andrew David Wong
cc839fc10a
Move "Version Scheme" to developer docs
This page appears to be written for a developer audience.
2021-06-19 20:41:11 -07:00
Andrew David Wong
2dbc8865e1
Use doc layout instead of sidebar layout
There appears to be no strong reason that these pages are using a
different layout, and having this separate layout significantly
increases the ongoing doc maintenance burden.
2021-06-19 20:39:34 -07:00
Andrew David Wong
04d3ead8bf
Fix "Notes" heading; update heading syntax 2021-06-19 20:06:33 -07:00
Andrew David Wong
a2511357a7
Mark pages as advanced 2021-06-19 02:36:05 -07:00
Andrew David Wong
7e3bc9511f
Update "Minimal Templates"
- Mark as advanced page
- Revise introduction
- Move list of available templates to new section
- Clarify installation commands
- Fix language and syntax errors
- Wrap text
2021-06-19 02:15:40 -07:00
deeplow
b9b49c4d2b
Mention why one would use minimal templates
Content credit: SvenSemmler https://qubes-os.discourse.group/t/debian-10-minimal-configuration/2603/54
2021-06-19 08:05:57 +00:00
Andrew David Wong
7c0a29a253
Add entry for "netvm" 2021-06-18 22:27:46 -07:00
Andrew David Wong
0a53418de1
Update glossary
- Add entry for "admin qube"
- Add entry for "named disposable" (QubesOS/qubes-issues#6709)
- Clarify disposable-related definitions (QubesOS/qubes-issues#6709)
- Add "previously known as" terms
- Clarify wording in various entries
2021-06-18 20:34:02 -07:00
Andrew David Wong
ba232b6b58
Improve organization and wording; fix typos 2021-06-18 12:23:43 -07:00
Andrew David Wong
b3c61ed5c0
Clarify definitions 2021-06-18 12:08:33 -07:00
Andrew David Wong
c178da955e
Update "How to Install Software"
- Explicitly state that software should be installed in a template
- Add a note for advanced users who might be interested in installing
  software in standalones and dom0
- Fix Markdown syntax and formatting
- Wrap text
2021-06-18 06:58:10 -07:00
Andrew David Wong
3d1d8bf37e
Update links 2021-06-18 06:47:40 -07:00
Andrew David Wong
f50d543155
Fix errors 2021-06-18 06:42:30 -07:00
Andrew David Wong
2c7982d391
Restore capitalization 2021-06-18 06:35:43 -07:00
Andrew David Wong
07c130df00
Wrap text and miscellaneous cleanup 2021-06-18 06:25:06 -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
50270f435c
Fix links 2021-06-18 03:09:09 -07:00
Andrew David Wong
88a4e0a4b5
Fix links 2021-06-18 02:59:26 -07:00
Andrew David Wong
2ae0ce9524
Mass replace "StandaloneVM" with "standalone"
Also updates the "Standalones and HVM" page.

QubesOS/qubes-issues#1015
2021-06-18 02:29:28 -07:00
Andrew David Wong
63498a6c17
Mass replace "TemplateVM" with "template"
QubesOS/qubes-issues#1015
2021-06-18 02:16:40 -07:00
Andrew David Wong
c07ee61ed8
Mass replace "DisposableVM" with "disposable"
QubesOS/qubes-issues#1015
2021-06-18 02:04:39 -07:00
Andrew David Wong
aea595397f
Mass replace "AppVM" and "TemplateBasedVM" with "app qube"
QubesOS/qubes-issues#1015
2021-06-18 01:55:53 -07:00
Andrew David Wong
719836c9f3
Replace "template-based qube" with "app qube"
See #748 and the glossary.
2021-06-18 01:34:07 -07:00
Andrew David Wong
132030119f
Update "How to Install Software"
- Update terminology (QubesOS/qubes-issues#1015)
- Add section on lack of template network access
- Move advanced topics to "Advanced" section
- Miscellaneous improvements
2021-06-18 01:25:09 -07:00
Andrew David Wong
4f3c513422
Update template doc
- Replace "TemplateVM" with "template" (QubesOS/qubes-issues#1015)
- Update other terminology
- Miscellaneous improvements
2021-06-18 01:22:23 -07:00
Andrew David Wong
e9fe17f2f2
Fix link text capitalization 2021-06-18 01:21:40 -07:00
Andrew David Wong
873da01b7b
Shorten "standalone qube" to "standalone"
Similar to "templates" and "disposables."
QubesOS/qubes-issues#1015
2021-06-18 01:19:44 -07:00
Andrew David Wong
7652e7edf8
Revamp glossary
- Replace "VM" with "qube" (QubesOS/qubes-issues#1015)
- Remove deprecated terms
- Remove some terms that are not Qubes-specific
- Alphabetize entries
- Miscellaneous improvements
2021-06-18 00:48:17 -07:00