Closed
Bug 1166597
Opened 9 years ago
Closed 9 years ago
Add links to "how to" pages from doc status pages
Categories
(Developer Documentation Graveyard :: MDN Meta Docs, defect)
Developer Documentation Graveyard
MDN Meta Docs
Tracking
(Not tracked)
RESOLVED
FIXED
People
(Reporter: jswisher, Assigned: fs)
Details
Our doc status pages are great for showing what areas need work, but they don't help people who don't already know how to do the relevant tasks. Just as we have links to task descriptions from the Getting Started page, we should have links to task descriptions from each section of the doc status pages. We already have some of these task descriptions, and some we need to write: * No tags: https://developer.mozilla.org/en-US/docs/MDN/Contribute/Howto/Tag * Needs* tags * Editorial reviews: https://developer.mozilla.org/en-US/docs/MDN/Contribute/Howto/Do_an_editorial_review * Technical reviews: https://developer.mozilla.org/en-US/docs/MDN/Contribute/Howto/Do_a_technical_review * Outdated pages * dev-doc-needed bugs * Documentation requests
Assignee | ||
Comment 2•9 years ago
|
||
You can see this in action on the CSS doc status page now: https://developer.mozilla.org/en-US/docs/MDN/Doc_status/CSS Use force-refresh for the others, or wait until auto-rebuild regenerates the pages. "Documentation requests" and "outdated pages" do not have "how-to" pages yet, but are also tasks that can vary a lot about what actually needs to get done in the end. I added a simple sentence for these two. Janet, does this look OK to you?
Flags: needinfo?(jswisher)
Reporter | ||
Comment 3•9 years ago
|
||
This looks good! For "Outdated pages", I suggest a little more detail: 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. For this CSS doc status page in particular, "Missing pages" could have a link to "How to document a CSS property" (https://developer.mozilla.org/en-US/docs/MDN/Contribute/Howto/Document_a_CSS_property). Not all topic areas have a how-to like that one.
Flags: needinfo?(jswisher)
Assignee | ||
Comment 4•9 years ago
|
||
Updated! Let me know if there is anything more to do here. I guess we are fine, so marking as fixed for now.
Status: NEW → RESOLVED
Closed: 9 years ago
Resolution: --- → FIXED
You need to log in
before you can comment on or make changes to this bug.
Description
•