Skip to content

Commit

Permalink
Update instructions for adding doc index links
Browse files Browse the repository at this point in the history
  • Loading branch information
Andrew David Wong committed Apr 8, 2021
1 parent 81f3282 commit 248673e
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion developer/general/doc-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 248673e

Please sign in to comment.