Commit Graph

178 Commits

Author SHA1 Message Date
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
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
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
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
5220089b53
Update references to "Getting Started"
QubesOS/qubes-issues#6756
2021-07-03 03:46:27 -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
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
527a2eb339
Update links 2021-06-21 00:38:18 -07:00
Andrew David Wong
bc138e0dc4
Update links 2021-06-20 21:54:36 -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
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
a2511357a7
Mark pages as advanced 2021-06-19 02:36:05 -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
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
7d3fd4fa26
Create general Privacy Policy; add mirror note
Based on @unman's proposal:
c52aaa6821

Original context:
https://qubes-os.discourse.group/t/qubes-website-privacy-policy/2235/
2021-06-17 11:06:21 -07:00
Andrew David Wong
76150ac9d3
Fix links 2021-06-17 07:01:53 -07:00
Andrew David Wong
59a4c8df11
Update links
QubesOS/qubes-issues#6701
2021-06-17 05:48:32 -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
9e9a3e6837
Update testing page
- Convert text warning into alert; add text
- Minor language improvements and fixes
- Normalize heading capitalization
2021-06-12 19:29:17 -07:00
Andrew David Wong
0ff457791c
Update Supported Versions: TemplateVMs
- Explain passing along upstream EOL notices
 - Add note regarding Debian 9 support in R4.0
 - Add section on Debian support policy
2021-06-07 17:27:49 -07:00
Andrew David Wong
898b14a2bd
End Fedora 32 TemplateVM support (EOL) 2021-05-25 09:05:35 -07:00
Tobias Killer
098f5b418c
Resolve open issues mentioned on Transifex 2021-04-17 10:57:16 +02: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
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
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
d9de60a551
Add Fedora 33 to supported templates for 4.0, 4.1
QubesOS/qubes-issues#6039
2021-02-24 16:49:11 -08:00
Andrew David Wong
aaa2aa1ad2
Clarify text 2021-01-03 11:59:10 -08:00
Andrew David Wong
401447bcde
Encourage users to stay informed of QSBs
- Add "Next steps: Security" section to installation guide
 - Add social media section to support page, as a way to receive news
   updates

Discussed in:
 - QubesOS/qubes-issues#6299
 - https://qubes-os.discourse.group/t/safety-when-forced-not-to-use-updater/2085
2021-01-03 08:08:37 -08:00
Andrew David Wong
6dd31abb80
Undo R1 and R2 version scheme retcon 2020-11-27 07:36:30 -08:00
Andrew David Wong
d9aad865d7
Reorganize Supported Versions page TemplateVM sections
- Consolidate tables to avoid need for cross-referencing
 - Drop unsupported versions
 - Consolidate and clarify TemplateVM version support policies
 - Make formatting and language more consistent
2020-11-26 06:21:47 -08:00
Andrew David Wong
198b9e6bc8
Clarify Debian TemplateVM support policy 2020-11-26 05:50:25 -08:00
Andrew David Wong
1b12cbc8d6
Suggest submitting HCL report after installation
QubesOS/qubes-issues#6231
2020-11-25 05:02:09 -08:00
Andrew David Wong
54fde72b02
Fix example order 2020-11-24 08:10:14 -08:00
Andrew David Wong
116cb05f4e
Update Fedora 31 support status
Fedora 31 has reached EOL.
2020-11-24 08:08:27 -08:00
PROTechThor
fa61755afd Amend installation guide and troubleshooting 2020-11-03 14:51:22 +01:00
Andrew David Wong
715e50236e
Improve installation destination warning 2020-09-26 05:49:42 -05:00
Andrew David Wong
f56bf6c037
Improve instructions for installing onto USB drives 2020-09-26 05:44:26 -05:00
Andrew David Wong
604bec3ddd
Remove deprecated Live USB page, redirect to Installation Guide 2020-09-14 03:19:25 -05:00
Andrew David Wong
9119bba439
Improve cross-linking of important documentation pages 2020-09-13 08:52:31 -05:00
Andrew David Wong
bb4acaeac1
Revise installation guides
These revisions focus mainly on improving language, presentation, and
organization. The core instructions are largely preserved, though some
new information and links to other resources are added.
2020-09-01 22:49:41 -05:00
Andrew David Wong
122fa55ead
Add sections on updating and backups 2020-08-31 15:39:30 -05:00
Andrew David Wong
96399b2593
Add section on trusting hardware 2020-08-31 15:37:25 -05:00
Andrew David Wong
60864a532c
Update qubes-users references to /support/
Now that we have a user forum in addition to qubes-users, it makes more
sense to link to /support/ than to link directly to qubes-users (or to
the forum, for that matter). This layer of redirection means allows us
to update just one thing (namely, the /support/ page) instead of having
to hunt through all the documentation every time support information
changes.
2020-08-22 23:18:08 -05:00
Marek Marczykowski-Górecki
d6ab2a6dba
Update supported versions
- remove old templates that are not going to be available in R4.1
- Fedora 30 is EOL now
2020-07-27 00:21:29 +02:00
Andrew David Wong
17efdc53d1
Update R4.1 dom0 OS to Fedora 32
QubesOS/qubes-issues#5923
2020-07-07 06:14:02 -05:00
Andrew David Wong
931e6b9a50
Update dead link
Thank you to user Bruno for pointing this out and supplying a
replacement link.
2020-07-01 06:38:36 -05:00
Andrew David Wong
6ab14dd9d2
Update Supported Versions with Fedora 32 template 2020-06-30 06:07:01 -05:00
Sarvottam Kumar
e26c8ab552
Update installation-guide.md 2020-05-16 23:05:17 +05:30
Andrew David Wong
bda320f1ad
Add Fedora 31 to Qubes 4.0 row and general support list 2020-04-30 08:58:54 -05:00
Death Grippin
52f482bcd3
Fix minor typos 2020-03-14 15:48:12 -04:00