From 248673e25e015cd4546c0b1104bca0b567b9add9 Mon Sep 17 00:00:00 2001 From: Andrew David Wong Date: Thu, 8 Apr 2021 06:37:48 -0700 Subject: [PATCH] Update instructions for adding doc index links Discussed in QubesOS/qubes-issues#6426 --- developer/general/doc-guidelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/developer/general/doc-guidelines.md b/developer/general/doc-guidelines.md index 320fc42b..601e8a96 100644 --- a/developer/general/doc-guidelines.md +++ b/developer/general/doc-guidelines.md @@ -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.