MDN/Archives/Kuma

Project "Kuma"

"Kuma" is a project to redevelop the MDN website. We will leverage the Kitsune codebase that the new SUMO is built on and plan to customize it to fit our needs. The Kitsune knowledge base (KB) will replace the current Deki wiki, and we will be integrating the Kitsune support forums and discussion forums as needed. Kuma will also benefit from Kitsune l10n, administration, and social interaction features.

Goals

• Improve the MDN experience for developers, demo authors, and documentation contributors.
  • Make it easier for planning, writing, and maintaining docs
  • Make it discoverable to help developers find what they need
  • Make it faster and more stable for visitors and contributors
  • Make it extensible to allow rapid development of new features
• Create a more robust system for l10n contributors
  • Better tracking and diffs so they know when we create new docs, update existing docs, or do anything for en-US
  • Dashboard for l10n progress and monitoring so locales can better manage their work

Strategy / Planning

• Collaborate with SUMO dev team to understand what is available in the Kitsune codebase and work through our own requirements to build a solid foundation for the MDN website on the Django framework.
  • Identify overlap in requirements for SUMO and MDN
    • SUMO team notes and Luke's dev analysis.
    • etherpad from Luke+Jay+James meeting
• New MDN IA
  • URL paths/structure

PRD

A draft of the MDN 1.0 PRD has most of the features we need to start the migration away from Deki and have a successful launch for Kuma. We plan to develop the initial functionality and test internally through a series of MDN 1.x releases, and will launch Kuma officially as MDN 2.0 when it's ready (tentatively Q42011).

The document includes a list of features and their priorities, which we will continue to revise with details and notes for reference. However, we will build out the official PRD on this wiki, starting with the high-level requirements and creating new sub-pages to dive into specific components and features.

Features

We will be convert our current features list into a summary table below and setup feature pages for each major component.

Component	Feature	Rank	Mstone	Owner
Wiki	Editor	P1	1.1	lcrouch
Wiki	Templates	P2	1.4	lorchard
Wiki	Editorial	P3	1.3	lcrouch
Wiki	Code Embedding	P3	1.4	lorchard
Wiki	Comments	P4	1.2	lcrouch
Wiki	File Attachements	P2	1.2	lcrouch
Wiki	Print and Export	P4	1.6	lcrouch
Search	Category filters	P2	1.3	lorchard
Search	l10n filters	P3	1.5	lorchard
Search	External sources in results	P5	1.9
Search	Rankings based on search terms and content ratings		1.8
Search	Topic areas and/or tags filters		1.8
Localization	Change tracking for en-US		1.5
Localization	Request queue for locales		1.8
Localization	Dashboard (stats, progress, etc)		1.8
Localization	Metrics by language (# of contributors, articles, edit intervals, etc)		1.8
Localization	Localized categories, tags, etc.		1.9
Content Management	Monitor deleted pages and restore		1.9
Content Management	Compare two versions of a page		1.5
Content Management	Mark pages, subtrees, etc. as read-only (or with other permissions)		1.3
Content Management	Metrics for docs activity (to help identify articles that need traction)		1.5
Content Management	Queries and batch processing of docs		1.9
Content Management	Endorse or bump articles (by admin/editorial team)		1.9
Engagement	Tweet this button		1.3
Engagement	Like button and/or ratings system		1.3
Engagement	Widgets to promote articles		1.9
Site Admin	Tags		1.3
Site Admin	RSS feeds		1.4
Site Admin	Users		1.7
Site Admin	Site-wide announcements		1.7
Site Admin	CSS customization via admin panel		1.9
Site Admin	View system logs via admin panel		1.7
Site Admin	Support browsing with HTTP (vs HTTPS for some content)		1.7
Users	Authentication		1.2
Users	Profile		1.3
Users	Dashboard		1.5
Demos	Tags		2.0
Demos	Sharing		2.0
Demos	JSFiddle integration		2.0
Migration	Content cleanup		1.4
Migration	URL namespaces		1.4
Migration	Redirects		1.4
API	Enable other apps/products to access and/or link to docs		2.0
API	Mark a selection as being a definition of a term		2.0

Milestones

• 1.0 - March 31 (staging)
  • Bugzilla buglist
  • Basecamp project
  • MDN apps => kitsune fork
    • clone https://github.com/jsocol/kitsune/tree/next ('next' branch)
    • push to github 'kuma'
      • https://github.com/mozilla/kuma
    • disable kitsune apps
    • move MDN 0.9.3 apps into kuma
    • create 'mdn' branch for 0.9.x dev
  • capture deki users into django
  • add kuma to hudson
    • https://hudson.mozilla.org/job/kuma/
  • create a kuma-stage server it bug 636576
  • web QA suite

• 1.1 - April 7 (staging)
  • enable kuma wiki - new & edit pages w/ slug field
    • see MDN/MDN:Kuma_Meeting_2011-03-18
  • fckeditor

Team Resources

The Kuma team uses various tools to manage its work, hold discussions, and track progress. These tools, and the differences between them, are outlined here.

Kuma Wiki

• Address: https://wiki.mozilla.org/MDN/Kuma
• Purpose: Track overall progress, share and collaborate on high-level details and (occasionally) lower-level details. An "outbound communication channel" that anyone can contribute to.

Basecamp

• Address: https://mozilla.basecamphq.com
• Purpose: Share assets (mockups, wireframes, etc.), provide feedback on those assets, and hold lengthy discussions

Bugzilla

• Address: https://bugzilla.mozilla.org/buglist.cgi?quicksearch=Kuma&list_id=334028
• Purpose: Assign tasks and track resolutions. Much of the discussion that happens between assignment and resolution takes place on Basecamp.

References

• Kuma related requirements/notes
  • Wiki docs TOC - docs team is organizing content under a consistent hierarchy.
  • etherpad from Luke+Jay+James meeting
• Other stuff
  • MDN programs and projects - home for everything related to the Mozilla Developer Network
  • MDN requirements - initial set of features and functionality we need for a good developer and documentation experience on MDN (more stuff will be added over time and a final PRD will be drafted soon)
  • Kitsune roadmap and requirements - home for everything related to the next version of SUMO
  • Overlap doc - early draft of the features that are shared between SUMO and MDN (more details will be added and unique features/tweaks for each application will be noted)