Types of doc issues
There are a couple of ways to notify the MDN content team about changes that are needed in documentation, or about new documentation that is needed. This article describes how documentation issues are handled in Bugzilla and GitHub, and how to help work on existing requests.
- dev-doc-needed keyword
- When a Mozilla product bug results in new features, or modifies existing ones, that affect documentation on MDN, the development team adds "dev-doc-needed" in the Keywords field of the product bug in Bugzilla. This sends a notification to the MDN team. (MDN team members often abbreviate "dev-doc-needed" to "DDN".)
- Documentation requests
- When someone notices that a document on MDN is incorrect or incomplete, they can file an issue in GitHub to request that it be fixed. Prior to January 2019, MDN doc requests were logged in Bugzilla, where there is still a large backlog.
How to help
If you're interested in working on DDN bugs or doc request issues, start by looking for an issue that you might want to help with.
- Product bugs with the dev-doc-needed keyword need some kind of change to MDN content because of the product change that was made. If you decide to tackle one of these, jump over to How to resolve a dev-doc-need bug.
- Doc requests that are prioritized as P5 are unlikely to be fixed by staff members, but fixes from community members are welcome. You can find lists of P5 bugs on Bugzilla, and P5 issues on GitHub.
If you've selected a doc request, use the following general strategy:
- Contact the person who the issue is assigned to; that person can help you figure out what you need to do to make the appropriate changes on MDN, and what would be considered "done" for that issue. If no one is assigned to the issue, you can post on the MDN discussion forum to ask for advice on how to proceed.
- If the current owner agrees, assign the bug to yourself. (If you realize you're unable to finish work on a bug, add an explanatory comment, and un-assign yourself.)
- When you are finished, ask for a review of your work. (The original owner is a good person to ask.) If the reviewer approves what you've done, close the bug.