summaryrefslogtreecommitdiffstats
path: root/docs/bug-mgmt/processes/doc-requests.rst
blob: dc390a27cbc5251ac46b8e24283374381720c1c3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
User documentation requests
===========================

If you are working on a change (bugfix, enhancement, or feature) which
would benefit from user-facing documentation, please use the
``user-doc-firefox`` flag to request it.

This flag can be modified by anyone with ``EDITBUGS`` privileges.

The default value of the flag is ``---``.

If the bug needs user-facing documentation, set the flag to
``docs-needed``. This flag will be monitored by the support.mozilla.org
(SUMO) team.

Once the docs are ready to be published, set the flag to
``docs-completed``.

If it’s determined that documentation is not need after setting the flag
to ``docs-needed``, update the flag to ``none-needed`` so we know that
it’s been reviewed.

Summary
-------

=========== == ==============
From           To
=========== == ==============
—           to none-needed
—           to docs-needed
docs-needed to none-needed
docs-needed to docs-completed
=========== == ==============

Notes
-----

A flag is used instead of the old keywords because flags can be
restricted to a subset of products and components.