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
Andrew David Wong
d2614cbd5f
Fix links
2021-06-17 09:23:17 -07: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
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
