Commit Graph

6521 Commits

Author SHA1 Message Date
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
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
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
fcc90a5908
Change title back to "Getting Started"
QubesOS/qubes-issues#6756
2021-07-03 03:42:25 -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
a5a4f16fbd
Update Qubes Forum URL 2021-07-01 06:59:37 -07:00
Andrew David Wong
fd6c8e28f8
Document wwwtest vs. wwwpreview
QubesOS/qubes-issues#6747
2021-06-29 15:44:02 -07:00
Andrew David Wong
a2e3dfe7a7
Document qubes-secpack PGP key inclusion criteria 2021-06-29 15:42:02 -07:00
Andrew David Wong
3253b6b91e
Update TestDeploy documentation
QubesOS/qubes-issues#6747
2021-06-29 14:58:18 -07:00
Andrew David Wong
dc22de87ab
Document TestDeploy 2021-06-29 14:23:26 -07:00
Andrew David Wong
decc4135f9
Add CI section; document PipelineRetry command (#1149) 2021-06-27 22:35:56 -07:00
Andrew David Wong
1c5aab4340
Add guidelines regarding angled brackets around variables
Added in response to:
https://qubes-os.discourse.group/t/how-can-i-create-a-template-hvm-of-any-os/4676

Also updates terminology and clarifies wording.
2021-06-27 22:25:46 -07:00
Andrew David Wong
b4e501f9cd
Merge branch 'ydirson-rpmmacros-typo' 2021-06-27 22:10:40 -07:00
Yann Dirson
04c8ea50b0 qubes-builder: fix typo in rpmmacros filename, improve its markup 2021-06-26 17:34:47 -04:00
Andrew David Wong
30e3cbe551
Merge branch 'deeplow-patch-17' 2021-06-26 07:22:21 -07:00
Andrew David Wong
4f26651215
Merge branch 'patch-17' of https://github.com/deeplow/qubes-doc into deeplow-patch-17 2021-06-26 06:28:21 -07:00
Andrew David Wong
0e2160e25a
Merge branch 'fepitre-skip-autostart' 2021-06-26 06:25:18 -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