doc-requests.rst (1103B)
1 User documentation requests 2 =========================== 3 4 If you are working on a change (bugfix, enhancement, or feature) which 5 would benefit from user-facing documentation, please use the 6 ``user-doc-firefox`` flag to request it. 7 8 This flag can be modified by anyone with ``EDITBUGS`` privileges. 9 10 The default value of the flag is ``---``. 11 12 If the bug needs user-facing documentation, set the flag to 13 ``docs-needed``. This flag will be monitored by the support.mozilla.org 14 (SUMO) team. 15 16 Once the docs are ready to be published, set the flag to 17 ``docs-completed``. 18 19 If it’s determined that documentation is not need after setting the flag 20 to ``docs-needed``, update the flag to ``none-needed`` so we know that 21 it’s been reviewed. 22 23 Summary 24 ------- 25 26 =========== == ============== 27 From To 28 =========== == ============== 29 — to none-needed 30 — to docs-needed 31 docs-needed to none-needed 32 docs-needed to docs-completed 33 =========== == ============== 34 35 Notes 36 ----- 37 38 A flag is used instead of the old keywords because flags can be 39 restricted to a subset of products and components.