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
Andrew David Wong
d2614cbd5f
Fix links
2021-06-17 09:23:17 -07:00
deeplow
4239ad7856
add "ssh-copy-id" to "Passwordless SSH Login"
2021-06-17 11:30:00 -04:00
deeplow
161a03f7bc
add notes about installing software with dom0 net
...
Add notes on how one can install software if the only network card was already to dom0.
2021-06-17 11:29:58 -04:00
deeplow
036d89eaa0
add troubleshooting message
2021-06-17 11:29:56 -04:00
deeplow
185f33eb7e
implemented requested changes
2021-06-17 11:29:54 -04:00
deeplow
0a6f37156e
update 7-year-old test-bench machine setup
...
Updates the developer documentation for remote test bench
2021-06-17 11:29:52 -04:00
Andrew David Wong
76150ac9d3
Fix links
2021-06-17 07:01:53 -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
84d3334325
Update doc guidelines about h1 headings and titles
...
QubesOS/qubes-issues#6701
2021-06-16 21:49:49 -07:00
Andrew David Wong
2c473241a8
Revert "Remove all instances of permalink: in YAML frontmatter"
...
This reverts commit c815e4c54chttps://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 24e6a8a616https://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
aca8ed14c7
Normalize instances of redirect_from:
...
QubesOS/qubes-issues#6701
2021-06-15 22:24:44 -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
6043c6e51d
Improve documentation guidelines page
...
- Create separate section for editing doc index
- Link to how-to-edit-doc-index section in contrib guide
- Link to how-to-edit-doc-index section in core vs. external section
- Link to how-to-add-images section in contrib guide
- Add "PR" abbreviation for those unfamiliar (not used on this
page but often used elsewhere and when linking to this page)
See QubesOS/qubes-issues#6694
2021-06-13 21:08:10 -07:00
WillyPillow
a77ff318bd
qvm-template: Update constraints regarding template RPM metadata
2021-06-09 17:25:45 +08:00
WillyPillow
76232f9a1f
qvm-template: Change template-licence to template-license
2021-06-09 17:25:43 +08:00
WillyPillow
8716d23f48
qvm-template: Reflect path changes in qubes-repo-templates
...
See 337efb1d3c
2021-06-09 17:25:42 +08:00
WillyPillow
2bc69fc466
Tweak slightly for clarity
2021-06-09 17:25:40 +08:00
WillyPillow
2de76980ae
Update info regarding time format
2021-06-09 17:25:38 +08:00
WillyPillow
01110f8253
Fix Google groups link
2021-06-09 17:25:36 +08:00
WillyPillow
96dce2dada
Add indication that qvm-template is not yet merged
2021-06-09 17:25:34 +08:00
WillyPillow
61fb01d673
Move mention of GSoC to Motivations section
2021-06-09 17:25:32 +08:00
WillyPillow
1473712618
Replace with atx headers
2021-06-09 17:25:30 +08:00
Andrew David Wong
a99b53ec11
Remove superfluous "Introduction" heading
2021-06-09 17:25:29 +08:00
WillyPillow
95ee4559ab
Fix incorrect feature name
2021-06-09 17:25:27 +08:00
WillyPillow
dd42704add
Fix link syntax.
2021-06-09 17:25:25 +08:00
WillyPillow
56cf2b768e
Fix whitespace.
2021-06-09 17:25:24 +08:00
WillyPillow
ec37cc6984
Add "Introduction" section.
2021-06-09 17:25:22 +08:00
WillyPillow
3ebde47b23
Replace "template VM" with "TemplateVM".
2021-06-09 17:25:20 +08:00
WillyPillow
54629daa32
Change title to "Template Manager".
2021-06-09 17:25:18 +08:00
WillyPillow
9249f074b3
Fix whitespace.
2021-06-09 17:25:16 +08:00
Andrew David Wong
3b314c84f7
Add YAML header
2021-06-09 17:25:11 +08:00
WillyPillow
44ea629d9f
Include documentation for template manager design
2021-06-09 17:25:02 +08:00
Andrew David Wong
deb33cde69
Copyedit text
2021-05-23 20:36:41 -07:00
Patrick Schleizer
7706060a47
clarify Qubes source code license
...
part of https://github.com/QubesOS/qubes-issues/issues/6500
2021-05-23 13:56:28 -04:00
herypt
90cf4497e4
Fix outdated documentation
2021-05-13 11:54:02 +02:00
Andrew David Wong
a660a92634
Merge branch 'resolve-transifex-issues' of https://github.com/tokideveloper/qubes-doc into tokideveloper-resolve-transifex-issues
2021-04-19 16:00:14 -07:00
Andrew David Wong
593f728ed6
Fix typo
2021-04-17 14:54:26 -07:00
Tobias Killer
190b740e32
Resolve open issues mentioned on Transifex
2021-04-17 10:31:11 +02:00
Tobias Killer
617330d026
Resolve open issues mentioned on Transifex
2021-04-16 19:45:56 +02:00
deeplow
bf64b68bcb
typo
2021-04-16 16:22:32 +00: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
Andrew David Wong
b546de3b8d
Merge branch 'md-convention-fullreflinks' of https://github.com/tokideveloper/qubes-doc into tokideveloper-md-convention-fullreflinks
2021-04-09 15:26:52 -07:00
Tobias Killer
7250daea53
Rewrite Markdown convention rule: Do not allow reference links
2021-04-09 09:30:39 +02:00
Andrew David Wong
248673e25e
Update instructions for adding doc index links
...
Discussed in QubesOS/qubes-issues#6426
2021-04-08 06:37:48 -07:00
Tobias Killer
ada42d7023
Add Markdown convention rule about full reference links
2021-04-08 11:25:36 +02:00
Marek Marczykowski-Górecki
16d88ced36
Add ref/lang to GSoD page
...
Commit this manually until CI is set for this task
2021-03-29 06:20:25 +02:00
