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
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
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
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
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
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
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
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
593f728ed6
Fix typo
2021-04-17 14:54:26 -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
Maya
820af56761
Add lang + ref tags to frontmatter
...
Those are fields used by the language switcher to correlate pages across
different languages, even if they have different names/paths/titles.
They are generated with the prepare_for_translation.py script.
2021-03-14 16:18:11 +01:00
Maya
8f8a8e50ea
Normalize frontmatter
...
- sort keys
- remove permalink from redirects
2021-03-14 16:18:10 +01:00
Maya
67a92614aa
Markdown formatting fixes
...
- mark all code blocks with ```
- unify empty lines between sections
- adjust list syntax (no space before dash)
- adjust headers to use Atx-style syntax
- remove trailing spaces
2021-03-14 16:18:10 +01:00
Andrew David Wong
6e9d015c50
Add info on adding and updating community links in ToC
...
QubesOS/qubes-issues#4693
2020-12-25 08:21:46 -08:00
Andrew David Wong
7610a66873
Update doc guidelines to reflect completed migration
...
https://github.com/QubesOS/qubes-issues/issues/4693
2020-12-07 22:57:40 -08:00
Andrew David Wong
c02686c6df
Update guidance regarding relative vs. absolute links
2020-12-07 17:09:34 -08:00
Andrew David Wong
c1f1ee902c
Update image linking syntax; use syntax on same page
2020-12-01 21:37:45 -08:00
Andrew David Wong
d33cd36170
Update examples; fix typo
2020-12-01 21:29:22 -08:00
Andrew David Wong
2c3293ddd1
Add missing link
2020-11-29 12:47:10 -08:00
Andrew David Wong
fa826f6066
Add guidelines on duplication and core vs. external docs
...
- Add new "Organizationl guidelines" section
- Add some relevant links in other sections
- Update heading syntax to account for new h3s
- Normalize heading case
2020-11-29 12:43:48 -08:00
Andrew David Wong
63379e80c6
Remove reference-style link guideline
...
Closes #1096
2020-11-23 10:17:10 -08:00
Andrew David Wong
3df2ffa6f6
Add guideline on syntactically distinguishing variables in commands
2020-11-23 07:08:35 -08:00
Andrew David Wong
17021f6cb7
Update doc guidelines regarding HTML, CSS, and images
2020-11-18 22:26:22 -08:00
Andrew David Wong
0e5a97785c
Add information about doc review security
2020-10-27 19:23:57 -07:00
Andrew David Wong
9b9d291256
Recommend universal Atx-style headings
2020-08-29 15:42:03 -05:00
Andrew David Wong
35e7f92bc7
Do not strictly require Atx-style headings on both sides
...
Having the headings on both the left and right sides is more difficult
to edit and maintain, and not much is gained from having them on both
sides. It's still fine to have them on both sides, but this is a
stylistic choice left to the author.
2019-08-09 22:01:50 -05:00
Andrew David Wong
d31c786942
Reorganize files to account for new "External" section
...
QubesOS/qubes-issues#4693
2019-05-26 19:32:45 -05:00
