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
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
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
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
deeplow
d00c2d932f
Minor improvements to the testbech instructions
2021-07-05 11:47:54 -04: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
5220089b53
Update references to "Getting Started"
...
QubesOS/qubes-issues#6756
2021-07-03 03:46:27 -07:00
Andrew David Wong
baa1df911c
Update Qubes Forum URLs
2021-07-01 07:03:05 -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
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
Yann Dirson
04c8ea50b0
qubes-builder: fix typo in rpmmacros filename, improve its markup
2021-06-26 17:34:47 -04: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
38fb2978c3
Wrap text
2021-06-26 06:02:01 -07:00
Andrew David Wong
1ddbdc77e4
Merge branch 'patch-57' of https://github.com/adrelanos/qubes-doc into adrelanos-patch-57
2021-06-26 06:01:36 -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
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
d3c9979d7e
Update terminology, links, heading syntax; wrap text
2021-06-22 10:39:03 -07:00
Andrew David Wong
1a4365fadb
Clarify intention and context of coding conventions
2021-06-22 06:05:53 -07:00
Andrew David Wong
c8752a2a57
Add "Coding conventions" section
2021-06-22 05:21:02 -07:00
Andrew David Wong
ef620f97a7
Refactor Admin API page
2021-06-22 01:25:49 -07:00
Andrew David Wong
f86d6c58c6
Move "Research" page to main repo
...
This file no longer contains any significant content.
2021-06-21 22:10:09 -07:00
Andrew David Wong
673629c976
Update doc index link
2021-06-21 21:03:28 -07:00
Andrew David Wong
527a2eb339
Update links
2021-06-21 00:38:18 -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
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
863f0ee9bd
Revert "Fix image example; wrap text"
...
This reverts commit 7d7ca0c592
2021-06-18 05:39:28 -07:00
Andrew David Wong
7d7ca0c592
Fix image example; wrap text
2021-06-18 05:27:55 -07:00
Andrew David Wong
b1d6139120
Restore hard wrapping at 80 characters
...
Turns out it's not a problem for localization, and it has significant
benefits. See the discussion on QubesOS/qubes-issues#2639 for details.
2021-06-18 05:17:57 -07:00
Andrew David Wong
e5a21f7488
Update attachment paths
2021-06-18 05:02:02 -07:00
deeplow
99083295b0
qubes-dom0-update has no install argument
2021-06-18 08:53:15 +00:00
deeplow
d33690dfd6
clarify "dnf --setopt" should be used
2021-06-17 17:03:48 +00:00
