Revision 86464 of MDC roadmap

  • Revision slug: User:Sheppy/MDC_roadmap
  • Revision title: MDC roadmap
  • Revision id: 86464
  • Created:
  • Creator: Sheppy
  • Is current revision? No
  • Comment 2 words added, 2 words removed

Revision Content

This is a rough outline to start prioritizing and scheduling the reorganization and infrastructure work I'm trying to get done on MDC.  I list these items in roughly the order in which I hope to address them, although as always that's subject to change.  Although I have two lists here, the two are ongoing at the same time.  I only have them separated for ease of maintaining the lists.

This is not a complete list of everything we want to do; rather, this is a list of stuff that I hope to do relatively soon, during my current MDC improvement cycle.

Content reorganization

Right now, the content on MDC has some significant organization problems.  There are several things we're going to be doing to help remedy that.

  1. New menu hierarchy.  I've been working on a new hierarchy of menus to help guide users to the documentation they need.  This has been out there for feedback for some time now, and I think is almost ready to roll out.  You can get a look at the proposed hierarchy and menus and let me know what you think.
  2. New templates for organizing content.  This is ongoing work.
    • Templates have been added for tagging interface methods as noscript, as well as for the version of Firefox and/or Gecko they were introduced with.
    • Similar templates are needed for constants and attributes.
    • We also need to add templates for building constant lists in interface documentation, so that individual constants can be linked to.  Currently, you can't link to constants' descriptions, which is sort of lame.
  3. Move content into a hierarchy.  Currently, most of our content is at the top level of the site.  This introduces several problems in terms of managing the content, and reduces efficiency, especially when using the linking features within Deki; when browsing article lists, the list is very long when everything's at the same level.
    • The first step on this is to migrate all the interface reference documentation into a subtree.  I've got an almost-ready script that automatically locates these and moves them.  It's being tested on a VM at home now, and I hope to be ready to use it on the live site very soon.
    • Much of the rest of this work will likely need to be done by hand, although we may be able to employ some automation for certain categories of content.
    • We need to devise a list of categories that need to become levels of the site's hierarchy.  I expect this will be discussed on dev-mdc in the near future.
  4. Start showing XUL and HTML samples in-place instead of requiring the reader to link elsewhere to see them.  This could be done either by directly embedding the content, or by using an iframe.

Back-end work

There's a lot of infrastructure work to do, too.

  1. Upgrade to Deki Lyons.  This should be done by the middle of May; IT has been alerted, and we're waiting on the release of the update.  We intend to upgrade roughly two weeks after it's released, to allow time for any issues to be noted and dealt with.  This blocks most of the other infrastructure work.
  2. Add an "I see an error" button that people can click on, which pops up a note saying "You know, you can fix this yourself, right?" note, with "OK, let me edit it" and "I think this fix is too much for me" buttons.  The former would go to the edit mode for the page, and the latter would take the user to Bugzilla to file a bug report against the article.
  3. Add some "widgets" that users can easily add to their user page, for things such as "File a bug" and "Search bugs" and that kind of thing, as well as possibly some pre-built templates for inserting lists of useful articles for various subject areas.  This would let people set their user page up as a personalized home page for MDC.
  4. Performance improvements.
    • We have a bug filed with Mindtouch about the cache control headers being whacked.
    • We will be using the HTML 5 offline resource support in the near future, to allow static resources to be cached on the user's system.  This should really help performance a lot, since we can avoid loading the JavaScript and skin resources on every page like we do now.
    • Deki Lyons will correct the problem with links in articles' tables of contents being full URLs instead of just links to the anchor; this will fix the problem of entire documents being reloaded every time you click on the TOC.
  5. Suggest content the contributor might like to work on.
    • Need a way for users to suggest content areas they understand well.
    • Then we can scan through articles marked as needing review or content and make suggestions.
    • We should also offer a way to look at failed searches to make suggestions as well.

 

Revision Source

<p>This is a rough outline to start prioritizing and scheduling the reorganization and infrastructure work I'm trying to get done on MDC.  I list these items in roughly the order in which I hope to address them, although as always that's subject to change.  Although I have two lists here, the two are ongoing at the same time.  I only have them separated for ease of maintaining the lists.</p>
<p>This is not a complete list of everything we want to do; rather, this is a list of stuff that I hope to do relatively soon, during my current MDC improvement cycle.</p>
<h2>Content reorganization</h2>
<p>Right now, the content on MDC has some significant organization problems.  There are several things we're going to be doing to help remedy that.</p>
<ol> <li>New menu hierarchy.  I've been working on a new hierarchy of menus to help guide users to the documentation they need.  This has been out there for feedback for some time now, and I think is almost ready to roll out.  You can get a <a class="internal" href="/User:Sheppy/New_main_page" title="User:Sheppy/New main page">look at the proposed hierarchy and menus</a> and let me know what you think.</li> <li>New templates for organizing content.  This is ongoing work.<br> <ul> <li>Templates have been added for tagging interface methods as noscript, as well as for the version of Firefox and/or Gecko they were introduced with.</li> <li>Similar templates are needed for constants and attributes.</li> <li>We also need to add templates for building constant lists in interface documentation, so that individual constants can be linked to.  Currently, you can't link to constants' descriptions, which is sort of lame.</li> </ul> </li> <li>Move content into a hierarchy.  Currently, most of our content is at the top level of the site.  This introduces several problems in terms of managing the content, and reduces efficiency, especially when using the linking features within Deki; when browsing article lists, the list is very long when everything's at the same level.<br> <ul> <li>The first step on this is to migrate all the interface reference documentation into a subtree.  I've got an almost-ready script that automatically locates these and moves them.  It's being tested on a VM at home now, and I hope to be ready to use it on the live site very soon.</li> <li>Much of the rest of this work will likely need to be done by hand, although we may be able to employ some automation for certain categories of content.</li> <li>We need to devise a list of categories that need to become levels of the site's hierarchy.  I expect this will be discussed on dev-mdc in the near future.</li> </ul> </li> <li>Start showing XUL and HTML samples in-place instead of requiring the reader to link elsewhere to see them.  This could be done either by directly embedding the content, or by using an iframe.</li>
</ol><h2>Back-end work</h2>
<p>There's a lot of infrastructure work to do, too.</p>
<ol> <li>Upgrade to Deki Lyons.  This should be done by the middle of May; IT has been alerted, and we're waiting on the release of the update.  We intend to upgrade roughly two weeks after it's released, to allow time for any issues to be noted and dealt with.  This blocks most of the other infrastructure work.</li> <li>Add an "I see an error" button that people can click on, which pops up a note saying "You know, you can fix this yourself, right?" note, with "OK, let me edit it" and "I think this fix is too much for me" buttons.  The former would go to the edit mode for the page, and the latter would take the user to Bugzilla to file a bug report against the article.</li> <li>Add some "widgets" that users can easily add to their user page, for things such as "File a bug" and "Search bugs" and that kind of thing, as well as possibly some pre-built templates for inserting lists of useful articles for various subject areas.  This would let people set their user page up as a personalized home page for MDC.</li> <li>Performance improvements.<br> <ul> <li>We have a bug filed with Mindtouch about the cache control headers being whacked.</li> <li>We will be using the HTML 5 offline resource support in the near future, to allow static resources to be cached on the user's system.  This should really help performance a lot, since we can avoid loading the JavaScript and skin resources on every page like we do now.</li> <li>Deki Lyons will correct the problem with links in articles' tables of contents being full URLs instead of just links to the anchor; this will fix the problem of entire documents being reloaded every time you click on the TOC.</li> </ul> </li> <li>Suggest content the contributor might like to work on.<br> <ul> <li>Need a way for users to suggest content areas they understand well.</li> <li>Then we can scan through articles marked as needing review or content and make suggestions.</li> <li>We should also offer a way to look at failed searches to make suggestions as well.</li> </ul> </li>
</ol>
<p> </p>
Revert to this revision