Git-Mirrors/qubes-doc
1
0
Fork 0
mirror of https://github.com/QubesOS/qubes-doc.git synced 2024-10-01 01:25:40 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update instructions for adding doc index links

Browse Source 
Discussed in QubesOS/qubes-issues#6426
This commit is contained in:
Andrew David Wong 2021-04-08 06:37:48 -07:00
parent 81f32829fc
commit 248673e25e
No known key found for this signature in database
GPG Key ID: 8CE137352A019A17
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
developer/general/doc-guidelines.md
View File

@ -145,7 +145,7 @@ External documentation can be anywhere else (such as forums, community websites,
External documentation should not be submitted to [qubes-doc].
If you've written a piece of documentation that is not appropriate for [qubes-doc], we encourage you to submit it to the [Qubes Community](https://github.com/Qubes-Community) project instead.
However, *linking* to external documentation from [qubes-doc] is perfectly fine.
Indeed, the maintainers of the [Qubes Community](https://github.com/Qubes-Community) project regularly submit PRs against [qubes-doc] to add and update links in the table of contents pointing to [Qubes Community](https://github.com/Qubes-Community) pages.
Indeed, the maintainers of the [Qubes Community](https://github.com/Qubes-Community) project should regularly submit PRs against [this file](https://github.com/QubesOS/qubesos.github.io/blob/master/_data/index.yml) to add and update Qubes Community links in the "External Documentation" section of the documentation table of contents.
The main difference between **core** (or **official**) and **external** (or **community** or **unofficial**) documentation is whether it documents software that is officially written and maintained by the Qubes OS Project.
The purpose of this distinction is to keep the core docs maintainable and high-quality by limiting them to the software output by the Qubes OS Project.