Commit Graph

6374 Commits

Author SHA1 Message Date
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
a1967f09ad
Fix typo 2021-07-10 14:19:45 -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
ef3440228f
Cross-link doc style guide and how-to pages 2021-07-10 13:49:27 -07:00
Andrew David Wong
b9bf32e6f8
Add section on serving website locally 2021-07-10 13:19:24 -07:00
Andrew David Wong
6de3d7f75f
Fix typo 2021-07-10 13:16:07 -07:00
Andrew David Wong
473f1075c8
Update example to reflect current style guide 2021-07-10 13:08:13 -07:00
Andrew David Wong
f608865417
Update doc style guide and instructions
- Explain why image linking is important
- Improve wording
- Fix link
- Minor improvements
2021-07-10 12:52:48 -07:00
Andrew David Wong
ce900bfea7
Merge branch 'deeplow-patch-23' 2021-07-10 12:50:23 -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
f0a0fd36fe
Merge branch 'unman-6769' (closes QubesOS/qubes-issues#6769) 2021-07-10 11:30:58 -07:00
Andrew David Wong
294e433b3d
Remove note about QubesOS/qubes-issues#6769 (fixed) 2021-07-09 05:19:05 -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
Andrew David Wong
ad2c60d91d
Merge branch '6769' of https://github.com/unman/qubes-doc into unman-6769 2021-07-09 04:23:31 -07:00
unman
d0bc9e70a2
Sentence case for titles 2021-07-09 01:06:41 +00:00
Andrew David Wong
e09d2d4c7a
Use shorter anchor text for doc index link 2021-07-08 10:17:34 -07:00
Andrew David Wong
bc5276a290
Improve section organization, formatting; fix link 2021-07-08 10:14:31 -07:00
Andrew David Wong
a867dbe06a
Add note about QubesOS/qubes-issues#6769 2021-07-08 08:24:13 -07:00
Andrew David Wong
d9ce14a1d0
Rename files in accordance with commit 676a13b 2021-07-08 08:09:41 -07: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
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
c4f59952f5
Merge branch 'deeplow-patch-22' 2021-07-06 07:14:25 -07:00
Andrew David Wong
eca8b6fb05
Merge branch 'patch-22' of https://github.com/deeplow/qubes-doc into deeplow-patch-22 2021-07-06 07:12:27 -07:00
Andrew David Wong
321ee9dedc
Merge branch 'gw0-patch-1' 2021-07-06 06:45:21 -07:00
Andrew David Wong
ecd72e6a9b
Merge branch 'patch-1' of https://github.com/gw0/qubes-doc into gw0-patch-1 2021-07-06 06:44:47 -07:00
Andrew David Wong
07da69bc0e
Revamp "Documentation Guidelines"
- Update contribution steps and first two images
- Improve source formatting and consistency
- Add information
- Improve organization and add subheadings
- Clarify and improve wording
2021-07-06 06:25:33 -07:00
deeplow
5972274c9d
start also script 2021-07-06 08:09:53 -04:00
deeplow
9849fea742
add steps to run script on every boot 2021-07-06 08:08:08 -04: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
deeplow
d00c2d932f
Minor improvements to the testbech instructions 2021-07-05 11:47:54 -04: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
65c3dd0f5e
Update "Issue Tracking"
- Reorder sections (https://github.com/QubesOS/qubes-doc/pull/1170#issuecomment-874019640)
- Add explanatory text
- Improve wording
- Append periods to complete declarative sentence headings
2021-07-05 05:05:56 -07:00
Andrew David Wong
9bb8a55ef2
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-05 04:48:29 -07:00
Andrew David Wong
779f3c4342
Append periods to complete declarative sentence headings 2021-07-05 04:44:48 -07:00
Andrew David Wong
5d9fa09ad4
Update "Help, Support, Mailing Lists, and Forum"
- Reorder sections (https://github.com/QubesOS/qubes-doc/pull/1170#issuecomment-874019640)
- Improve wording of "where to discuss Qubes" section (#1170)
- Add links to discussion guidelines
2021-07-05 04:40:24 -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
611670fcf1
Merge branch 'ninavizz-patch-2' 2021-07-03 04:19:27 -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