[2.2.x] Refs #31029 -- Added note about :rfc: role in writing documentation docs.

Backport of 42df1b178b from master
2019-11-26 13:07:55 +01:00 · 2019-11-26 13:07:55 +01:00 · 57f5a7e36b
parent 3cf70df468
commit 57f5a7e36b
1 changed files with 4 additions and 0 deletions
--- a/docs/internals/contributing/writing-documentation.txt
+++ b/docs/internals/contributing/writing-documentation.txt
@ -232,6 +232,10 @@ documentation:
    Five
    ^^^^

+* Use :rst:role:`:rfc:<rfc>` to reference RFC and and try to link to the
+  relevant section if possible. For example, use ``:rfc:`2324#section-2.3.2```
+  or ``:rfc:`Custom link text <2324#section-2.3.2>```.
+
 Django-specific markup
 ======================