MozQA documentation status

This page tries to track ongoing documentation work for MDN QA docs. Feel free to contribute!

Summary

Pages No tags Needs* tags Missing tags Editorial reviews Technical reviews Outdated pages Dev-doc-needed bugs Documentation requests Missing pages
100 26 (26%) 10 (10%) 0 (0%) 5 (5%) 5 (5%) 61 (61%) 0 (0%) 94 (94%) 26 (26%)

See also localization status of this section.

No tags

Found 26 pages. Learn more about how to tag pages.

Needs* tags

Found 10 pages. Learn more about how to deal with meta-tags.

Editorial reviews

Found 5 pages. Learn more about how to do an editorial review.

Technical reviews

Found 5 pages. Learn more about how to do a technical review.

Outdated pages

Found 61 pages. These pages haven't been updated in over a year. Outdated pages can have problems with both content and format. Look at these pages and consider: Is this page talking about the Web of today? Does it look consistent with newer pages in this topic area? If not, make any needed changes.

Documentation requests

Found 94 bugs. Documentation request bugs can contain various kinds work related to MDN pages. Read through the bug and ask questions in the bug if in doubt.

Bug Summary
87663 Update and organize Gecko style system documentation
213699 Write PAC docs
321093 helloworld.zip file missing due to expired domain
412905 Note NS_DebugBreak_P() in Linux debugging FAQ
431881 Runtime-Tracing document is outdated. Update is needed.
485944 Document nsIVariant pretty please
494970 Document Mozilla External String Guide
634848 WinDbg instructions point to wrong location for debug log in Windows 7
649669 need a "now to build Firefox like a pro" type of article
682829 IE to Mozilla migration guide needs to be reviewed for correctness and updated
691246 Browser detection guide is severely out of date
779833 Document mechanisms for determining information useful to web app developers
807521 Implement code sample for Social API
839418 Move pages into XPCOM Interface Reference subtree
855636 Show footer with all versions on "Firefox <XX> for developers"-pages
859827 Make Document for MOZ_PGO_INSTRUMENTED environment variant
866083 Wrong link at Packaging_Weblock page
868832 Improve the URI main page
872888 Documentation for building Thunderbird unclear
877451 Add list of table classes to editor guide
884860 Add YouTube embedding button documentation to the MDN editor guide
903768 "How to Submit a Patch" / "Using Mercurial" should give an example of correct patch headers
910103 Document CSS Grids
917855 content in MDN editor is not the same as the resulting content on the documentation page
920205 Shell prompt inclusion is inconsistent, and very confusing.
925683 Il manque une page sur les fomulaires de contact.
926694 Clean up organization of Firefox Mobile docs
933441 Update mochitest documentation for mach
933664 Video codec documentation needs a rewrite
935166 nsIInputStreamChannel documentation
936491 Android build instructions should be on MDN
941692 Broken Links to Rhino apidocs
950796 The source code editor should indent properly
950811 The 'Event Guide' needs a high level organization
951728 Write new MDN style guide
951729 Finish MDN user guide content
951730 Complete the MDN contributor guide
952156 "Managing Modals and Non Modal Dialogs" wiki page missing, feature request(s)
959815 create a patch documentation needs consolidation
960944 Remove or relicense all "Alternate License Block" content
970029 https://developer.mozilla.org/en/docs/JSS/JSS_Provider_Notes
971293 Document overflow="true" attribute of <treecol> element
973679 Missing documentation for BookmarkHTMLUtils.jsm
985355 Inline badge layout should be unified
1024530 The documentation for the PR_LOG has not been written
1056026 Update Firefox_for_developers macro to list newer versions too
1062488 Request for workflow diagram, for installable apps dev recommendations page
1081114 How to ensure the FX password manager recognizes password fields as such
1083494 <menugroup> xul element documentation at MDN
1094346 Geolocation documentation needs cleanup and mention of Firefox OS
1095376 No explanation for nsresult, error status associated with the request, nsIRequest
1113794 Add Firefox Accounts as a proper zone
1119251 Accessibility: External links
1127403 Mdn says that firefox compiles with gcc 4.6, but actually the min version is 4.7.
1129496 Revise or remove the Connect Zone
1135648 Rewrite bug reporting guidelines
1137030 Link for "How to Write a Proper Bug Report Part 2" is broken
1160554 Remove all uses of inline styles
1161964 JXON library broken since FF35
1162764 Top-level MDN Page should focus on the big picture, not details - MozillaWiki
1167992 Add Russian versions of some tags for search filters and topics
1168700 Broken links on "Thunderbird Binaries" MDN page
1171788 Spidermonkey lack of usable documentation
1187860 Document link not found https://developer.mozilla.org/fr/docs/Games/Workflows/HTML5_Gamedev_Phaser_Device_Orientation_FR
1188751 Add template for general info about DOM events
1188838 Add JSON template for DOM events
1189700 Better beginner's documentation for CORS
1192567 Provide description for "embedding" on Mozilla Source Code Directory Structure
1193072 Update docs for ftp://ftp.mozilla.org going away
1193457 broken link to IPDL/Processes_and_Threads
1195781 Document 'distributed node' in the Glossary
1195832 Document HTMLSelectElement.selectedIndex
1201405 Update doc "Debugging a XULRunner Application"
1202174 Irrelevant link in https://developer.mozilla.org/en-US/docs/ARIA/Accessible_Rich_Internet_Applications
1202694 Change cookie library on https://developer.mozilla.org/en-US/docs/Web/API/document/cookie
1207271 Link to Sample Extension in Getting Started with Firefox Extensions is broken
1207588 Page gives no clue how to step through code on Linux
1208816 Document XPathResult
1208958 confusing documentation for absolute positioning example
1211259 Missing Screenshots in page
1211345 URL - Web APIs / Browser compatibility / Mobile - Chrome 45 Android has URL and URLUtils, webkitURL is deprecated
1212760 Use .properties for the event summary tables
1214627 CSS_animated_properties link is broken
1214744 Dead link for download example
1216900 404 for page action in web extensions
1217568 Change class="tip" to class="note"
1218109 A message is sent to the worker onclick or onenter, but not onchange, despite the fact that the code says "onchange" and the commentary says it works.
1218456 HTMLAnchorElement.click() does not trigger if element is not in document DOM
1220146 fix invalid link "getting started with cfx"
1220592 Combobox bug for select
1223182 Fate of ForceRTL addon home page
1224322 Link https://developer.mozilla.org/MDN/Contribute/Creating_and_editing_pages#Creating_a_new_page does not exist
1224799 Mistake in the Russian language
1224966 Code on developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/deriveKey will not run, has many bugs

Browse as bug list.

Localizations

Please help us to localize this documentation into different languages. Read more about how to translate.

Language Pages Translated Translations up to date

General plan for QA docs

Mozilla has lots of QA documentation available: QMO, Main MDN QA landing page, Firefox OS automated testing landing page, and more. We ought to streamline our QA content by weeding out the obsolete stuff, updating the out of date stuff, and turning the different resources into a more cohesive resource.

Team

  • Chris Mills: MDN editor
  • Marcia Knous: Main QA contact

Join the project

MDN is built by you, the reader! If you'd like to help make this documentation real, we'd like to hear from you. You may contact the writing team by clicking on their names above, or on our mailing list. If you're a new MDN contributor, please have a look at our contributor guide. You can also join the conversation in our IRC channel #mdn.

Goals

Audit our current QA content

  • Write a plan for reorganizing it into a more cohesive resource that lives on MDN.
  • Migrate the non MDN content over to MDN.
  • Update and reorganize the existing material on MDN.
  • Make it easier for QA staff and volunteers to help perform QA work.

Target milestones

TBD: This work is not super urgent, but it would be nice to do it soon.

Note: Each milestone bug should block bug 1054344, which is a tracking/meta bug for this project.

User stories

  • I want to write tests for Mozilla products
  • I want to Help perform QA/testing work on Mozilla products
  • I want to find out what tools I need to use to do QA work, what workflow I'd use, and how to get started.
  • If I want to help with testing of Firefox, Firefox OS, or other Mozilla projects, where do I find out what needs to be tested?

Documents needed

Mainly reference and guide documents. This is mainly TBD. This can be done after the audit of existing docs.

Existing documents

Notes

The following items were discussed in a meeting between Chris Mills and the QA staff.

What should be kept where, on MDN?

Should we keep everything under a top level QA node, or should that node just contain generic stuff like introduction, how QA works at Moz, what all the tools are, how to get involved in the community, call to action, etc.? We could then put more applied Firefox / Firefox OS - specific stuff in the relevant zones and link to those from the main QA node. I think this latter idea is better for organization, as people are more like to think product first, then QA, rather than QA first, then product, although both camps do probably exist. This would allow us to cover both.

What should be moved over from QMO?

This is up for discussion. The content (on both MDN and QMO) needs to be audited to work out what stuff should be kept, and what stuff can be dumped due to being out of date or dupe.

There was also the question of whether the community / call to action stuff should remain on QMO, but the actual content should go on MDN, as QMO already has a bit of a following/page rank

I (Chris) personally think everything should just go on MDN, as MDN's page ranking will be higher, and it's good to have everything in one place and not fragmented. Plus if it is on MDN, it is all under the remit of the MDN editors, so we can maintain it.

Tips and tricks (for example B2G tips and tricks and QA tips and tricks) should go somewhere sensible as well.

Should QA be a zone?

I think so. I think QA falls under the zone definition, in that it is a specific function, product or action.

Next steps

  1. QA team to audit existing material.
  2. Chris Mills to work out where to put all the material, and draw up plan for content strategy

See also

This QMO Etherpad for further discussion/raw notes.

Document Tags and Contributors

 Contributors to this page: fscholz, jswisher, chrisdavidmills
 Last updated by: fscholz,