MDN/Archives/Kuma: Difference between revisions

m
Jswisher moved page MDN/Kuma to MDN/Archives/Kuma
m (Jswisher moved page MDN/Kuma to MDN/Archives/Kuma)
 
(45 intermediate revisions by 8 users not shown)
Line 1: Line 1:
= Launch Update =
Kuma launched August 3, 2012.
This page is now an archive of the pre-launch process
= Introduction =
= Introduction =
"Kuma" is a project to redevelop the MDN website.  We will leverage the [[Support/Kitsune | 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.
"Kuma" is a project to redevelop the MDN website.  We will leverage the [[Support/Kitsune | 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.
Line 9: Line 13:
** Make it extensible to allow rapid development of new features
** Make it extensible to allow rapid development of new features
* '''Create a more robust system for l10n contributors'''
* '''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
** Better tracking and diffs so they know when en-US authors 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
** Dashboard for l10n progress and monitoring so locales can better manage their work


= Strategy and Planning =
= Schedule =
 
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 in July 2012.
 
==Roadmap & Milestones==


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)'''.
    8-30 June - testing (formal and informal)
    7-8 July - bug hunt with Mozilla QA
    10 July - deki shut off for updates (browse only) - final content migration, link to kuma "beta" for browsing
    10-15 July - writing/editing on kuma, continue testing, verify bug fixes
    16 July - cutover


== Team Resources==
See the '''[[MDN/Milestones|MDN Milestones]]''' page for a detailed roadmap and release schedule.
The Kuma team uses various tools to manage their work, hold discussions, and track progress. These tools, and the differences between them, are outlined here.


'''Kuma Wiki'''
==Testing==
* 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'''
We are ramping up testing as we approach the launch of Kuma!
* Address: https://mozilla.basecamphq.com
* [[MDN/Kuma/Test Weekend May 2012|Informal test weekend: Friday, May 11 through Sunday, May 13]]
* Purpose: Share assets (mockups, wireframes, etc.), provide feedback on those assets, and hold lengthy discussions
* [[MDN/Kuma/Test 8 June 2012|8 June - 10 June: Informal test weekend]]
* [[MDN/Kuma/Test 14-24 June 2012|14 June - 30 June: Test Adding and Editing Content (usual site activities)]]
* [[MDN/Feedback/July_5,_2012_Release|7 July - 8 July: bug hunting with Mozilla QA]]
* 9-13 July - bug and template fixes, editing content on kuma platform


'''Bugzilla'''
'''Bugzilla'''
* Address: https://bugzilla.mozilla.org/buglist.cgi?quicksearch=Kuma&list_id=334028
* 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.
* Purpose: Assign tasks and track resolutions.
 
'''Submitting bugs'''
 
* Please use this [http://mzl.la/mdn-bug Bug template].


== Features ==
== Features ==


=== Feedback to consider ===
=== Background ===


* [https://docs.google.com/document/d/1O_TsQzLvwPdC2NvPNXliFNAWH063GpUtEa5jXH_Pf6E/edit?hl=en# UserVoice]: Feedback on the current MDN website.
* [https://docs.google.com/document/d/1O_TsQzLvwPdC2NvPNXliFNAWH063GpUtEa5jXH_Pf6E/edit?hl=en# UserVoice]: Feedback on the current MDN website.
* [http://groups.google.com/group/mozilla.dev.mdc/browse_thread/thread/2db5c57cb6629b64?pli=1 Localization]: We need to review and see what is possible based on the requests of localizers around the world.
* [http://groups.google.com/group/mozilla.dev.mdc/browse_thread/thread/2db5c57cb6629b64?pli=1 Localization]: We need to review and see what is possible based on the requests of localizers around the world.


=== Miscellaneous References ===
* Kuma related requirements/notes
* Kuma related requirements/notes
** [http://etherpad.mozilla.org:9000/mdn-toc Wiki docs TOC] - docs team is organizing content under a consistent hierarchy.
** [http://etherpad.mozilla.org:9000/mdn-toc Wiki docs TOC] - docs team is organizing content under a consistent hierarchy.
Line 66: Line 81:
* [http://etherpad.mozilla.org:9000/NXsamRPw1U Etherpad from the Luke/Jay/James meeting]
* [http://etherpad.mozilla.org:9000/NXsamRPw1U Etherpad from the Luke/Jay/James meeting]


=== Comprehensive Feature List ===
= Development =
A comprehensive list of features is provided below. Each feature has its own Wiki page that provides more detail and, in some cases, specific tasks that must be completed.
=== Scrum ===
The Kuma team will be using Scrum to manage development. Please see the [[Scrum|Scrum page]] and [[Scrum/Guide|Scrum Guide]] for more information about the framework.
 
The team decided that it would be easiest to manage Scrum user stories with Bugzilla, and has written a [[MDN/Kuma/Bugzilla_Scrum#Bugzilla_Fields|guide]] for doing so.
 
=== Comprehensive Feature Request List ===
A comprehensive list of features that have been requested on MDN is provided below. Each feature has its own Wiki page that provides more detail and, in some cases, specific tasks that must be completed.


This list is a compilation and formalization of existing feature lists (including the [http://etherpad.mozilla.com:9000/kumafeatureslist feature EtherPad], the [http://bit.ly/mdn10prd MDN 1.0 PRD], and the [https://spreadsheets.google.com/ccc?key=0AqPOgw3oBI8ldFRLd3JtOFdFclR1cGpXZHJLemR6YUE&authkey=CNSbyV4&hl=en#gid=2 MDN / SUMO Shared Components PRD]), and as such is fairly comprehensive.
This list is a compilation and formalization of existing feature lists (including the [http://etherpad.mozilla.com:9000/kumafeatureslist feature EtherPad], the [http://bit.ly/mdn10prd MDN 1.0 PRD], and the [https://spreadsheets.google.com/ccc?key=0AqPOgw3oBI8ldFRLd3JtOFdFclR1cGpXZHJLemR6YUE&authkey=CNSbyV4&hl=en#gid=2 MDN / SUMO Shared Components PRD]), and as such is fairly comprehensive.
Line 73: Line 94:
{| class="fullwidth-table sortable" style="width: 825px"
{| class="fullwidth-table sortable" style="width: 825px"
|-
|-
| style="font-weight: bold; background: #DDD; width: 50px" | Component
| style="font-weight: bold; background: #DDD; width: 70px" | Component
| style="font-weight: bold; background: #DDD; " | Feature
| style="font-weight: bold; background: #DDD; " | Feature
| style="font-weight: bold; background: #DDD; width: 25px;" | Rank
| style="font-weight: bold; background: #DDD; width: 25px;" | Rank
| style="font-weight: bold; background: #DDD; width: 25px;" | Mstone
| style="font-weight: bold; background: #DDD; " | Release
| style="font-weight: bold; background: #DDD; " | Owner
| style="font-weight: bold; background: #DDD; " | Notes
|-
|-
| Wiki
| Wiki
| [[MDN/Kuma/Features/Editing|Editing]]
| [[MDN/Kuma/Features/Editing|Editing]]
| P1
| P1
| 1.1
| July 2012
| lcrouch
|  
|-
|-
| Wiki
| Wiki
| [[MDN/Kuma/Features/Templates|Templates]]
| [[MDN/Kuma/Features/Templates|Templates]]
| P2
| P2
| 1.4
| July 2012
| lorchard
|  
|-
|-
| Wiki
| Wiki
| [[MDN/Kuma/Features/EditorialTools|Editorial tools]]
| [[MDN/Kuma/Features/EditorialTools|Editorial tools]]
| P3
| P3
| 1.3
| July 2012
| lcrouch
| some features
|-
|-
| Wiki
| Wiki
| [[MDN/Kuma/Features/CodeEmbedding|Code embedding]]
| [[MDN/Kuma/Features/CodeEmbedding|Code embedding]]
| P3
| P3
| 1.4
| July 2012
| lorchard
|  
|-
|-
| Wiki
| Wiki
| [[MDN/Kuma/Features/Commenting|Commenting]]
| [[MDN/Kuma/Features/Commenting|Commenting]]
| P4
| P4
| 1.2
| TBD
| lcrouch
|  
|-
|-
| Wiki
| Wiki
| [[MDN/Kuma/Features/FileAttachments|File attachments]]
| [[MDN/Kuma/Features/FileAttachments|File attachments]]
| P2
| P2
| 1.2
| July 2012
| lcrouch
|  
|-
|-
| Wiki
| Wiki
| [[MDN/Kuma/Features/PrintAndExport|Print and export]]
| [[MDN/Kuma/Features/PrintAndExport|Print and export]]
| P4
| P4
| 1.6
| TBD
| lcrouch
|  
|-
|-
| Search
| Search
| [[MDN/Kuma/Features/CategoryFilters|Category filter]]
| [[MDN/Kuma/Features/CategoryFilters|Category filter]]
| P2
| P2
| 1.3
| TBD
| lorchard
|  
|-
|-
| Search
| Search
| [[MDN/Kuma/Features/LocalizationFilter|Localization filter]]
| [[MDN/Kuma/Features/LocalizationFilter|Localization filter]]
| P3
| P3
| 1.5
| TBD
| lorchard
|  
|-
|-
| Search
| Search
| [[MDN/Kuma/Features/ExternalSearchResults|External search results]]
| [[MDN/Kuma/Features/ExternalSearchResults|External search results]]
| P5
| P5
| 1.9
| TBD
|  
|  
|-
|-
| Search
| Search
| [[MDN/Kuma/Features/ImprovedSearchRelevancy|Improved search relevancy]]
| [[MDN/Kuma/Features/ImprovedSearchRelevancy|Improved search relevancy]]
|  
| P3
| 1.8
| TBD
|
|some features available in July
|-
|-
| Search
| Search
| [[MDN/Kuma/Features/TagFilter|Tag filter]]
| [[MDN/Kuma/Features/TagFilter|Tag filter]]
|  
| P3
| 1.8
| TBD
|
|
|-
|-
Line 154: Line 175:
| [[MDN/Kuma/Features/Localization/ChangeTracking|Change tracking for en-US]]
| [[MDN/Kuma/Features/Localization/ChangeTracking|Change tracking for en-US]]
|  
|  
| 1.5
| July 2012
|
|
|-
|-
Line 160: Line 181:
| [[MDN/Kuma/Features/Localization/RequestQueue|Localization request queue]]
| [[MDN/Kuma/Features/Localization/RequestQueue|Localization request queue]]
|  
|  
| 1.8
| July 2012
|
| some features pushed to post-launch
|-  
|-  
| Localization
| Localization
| [[MDN/Kuma/Features/Localization/Dashboard|Localization dashboard]]
| [[MDN/Kuma/Features/Localization/Dashboard|Localization dashboard]]
|  
| P3
| 1.8
| TBD
|
|
|-
|-
| Localization
| Localization
| [[MDN/Kuma/Features/MetricsByLanguage|Metrics by language]]
| [[MDN/Kuma/Features/MetricsByLanguage|Metrics by language]]
|  
| P3
| 1.8
| TBD
|
|
|-
|-
| Localization
| Localization
| [[MDN/Kuma/Features/LocalizedTags|Localized tags and categories]]
| [[MDN/Kuma/Features/LocalizedTags|Localized tags and categories]]
|  
| P3
| 1.9
| TBD
|
|
|-
|-
| Localization
| Localization
| [[MDN/Kuma/Features/PhraseTranslation|Phrase translation service]]
| [[MDN/Kuma/Features/PhraseTranslation|Phrase translation service]]
|  
| P4
|
| TBD
|
|
|-
|-
| Localization
| Localization
| [[MDN/Kuma/Features/LocalizationAssociations|Maintain association between localizations]]
| [[MDN/Kuma/Features/LocalizationAssociations|Maintain association between localizations]]
|  
| P1
|
| July 2012
|
|
|-
|-
Line 196: Line 217:
| [[MDN/Kuma/Features/DeleteAndRestore|Delete and restore]]
| [[MDN/Kuma/Features/DeleteAndRestore|Delete and restore]]
|  
|  
| 1.9
| July 2012
|
| Restore function post-launch
|-
|-
| Content Management
| Content Management
| [[MDN/Kuma/Features/ComparePages|Compare two versions of a page]]
| [[MDN/Kuma/Features/ComparePages|Compare two versions of a page]]
|  
| P2
| 1.5
| July 2012
|
|
|-
|-
| Content Management
| Content Management
| [[MDN/Kuma/Features/ReadOnly|Mark pages, subtrees, etc. as read-only]]
| [[MDN/Kuma/Features/ReadOnly|Mark pages, subtrees, etc. as read-only]]
|  
| P3
| 1.3
| TBD
|
|
|-
|-
| Content Management
| Content Management
| [[MDN/Kuma/Features/DocMetrics|Metrics for doc activity]]
| [[MDN/Kuma/Features/DocMetrics|Metrics for doc activity]]
|  
| P1
| 1.5
| July 2012
|
|
|-
|-
| Content Management
| Content Management
| [[MDN/Kuma/Features/BatchProcessing|Queries and batch processing of docs]]
| [[MDN/Kuma/Features/BatchProcessing|Queries and batch processing of docs]]
|  
| P2
| 1.9
| TBD
|
| some features in July 2012
|-
|-
| Content Management
| Content Management
| [[MDN/Kuma/Features/Endorse|Endorse or bump articles]]
| [[MDN/Kuma/Features/Endorse|Endorse or bump articles]]
|  
| P4
| 1.9
| TBD
|
|
|-
|-
| Engagement
| Engagement
| [[MDN/Kuma/Features/TweetButton|"Tweet this" button]]
| [[MDN/Kuma/Features/TweetButton|"Tweet this" button]]
|  
| P4
| 1.3
| TBD
|  
|  
|-
|-
| Engagement
| Engagement
| [[MDN/Kuma/Features/Rating|Rating system]]
| [[MDN/Kuma/Features/Rating|Rating system]]
|  
| P4
| 1.3
| TBD
|  
|  
|-
|-
| Engagement
| Engagement
| [[MDN/Kuma/Features/ArticlePromotionWidgets|Article promotion widgets]]
| [[MDN/Kuma/Features/ArticlePromotionWidgets|Article promotion widgets]]
|  
| P3
| 1.9
| TBD
|  
|  
|-
|-
| Site Admin
| Site Admin
| [[MDN/Kuma/Features/TagManagement|Tag management]]
| [[MDN/Kuma/Features/TagManagement|Tag management]]
|  
| P2
|
| TBD
|  
| some features in July
|-
|-
| Site Admin
| Site Admin
| [[MDN/Kuma/Features/TalkUserTags|No tags for talk or user pages]]
| [[MDN/Kuma/Features/TalkUserTags|No tags for talk or user pages]]
|  
| P3
| 1.3
| TBD
|  
|  
|-
|-
| Site Admin
| Site Admin
| [[MDN/Kuma/Features/RSSFeeds|RSS feeds]]
| [[MDN/Kuma/Features/RSSFeeds|RSS feeds]]
|  
| P2
| 1.4
| July 2012
|  
| only for edits in first release
|-
|-
| Site Admin
| Site Admin
| [[MDN/Kuma/Features/UserManagement|User management]]
| [[MDN/Kuma/Features/UserManagement|User management]]
|  
| P1
| 1.7
| July 2012
|  
|  
|-
|-
| Site Admin
| Site Admin
| [[MDN/Kuma/Features/SiteAnnouncements|Site-wide announcements]]
| [[MDN/Kuma/Features/SiteAnnouncements|Site-wide announcements]]
|  
| P2
| 1.7
| July 2012
|  
|  
|-
|-
| Site Admin
| Site Admin
| [[MDN/Kuma/Features/CustomizeCSS|Easily customize CSS]]
| [[MDN/Kuma/Features/CustomizeCSS|Easily customize CSS]]
|  
| P2
| 1.9
| TBD
|  
|  
|-
|-
| Site Admin
| Site Admin
| [[MDN/Kuma/Features/AdminPanelLogs|Logs in the admin panel]]
| [[MDN/Kuma/Features/AdminPanelLogs|Logs in the admin panel]]
|  
| P2
| 1.7
| July 2012
|  
|  
|-
|-
| Site Admin
| Site Admin
| [[MDN/Kuma/Features/HTTPBrowsing|HTTP browsing]]
| [[MDN/Kuma/Features/HTTPBrowsing|HTTP browsing]]
|  
| P3
| 1.7
| TBD
|
|
|-
|-
| Users
| Users
| [[MDN/Kuma/Features/UserAuthentication|User authentication]]
| [[MDN/Kuma/Features/UserAuthentication|User authentication]]
|  
| P1
| 1.2
| July 2012
|  
|  
|-
|-
| Users
| Users
| [[MDN/Kuma/Features/UserProfile|User profile]]
| [[MDN/Kuma/Features/UserProfile|User profile]]
|  
| P3
| 1.3
| TBD
|  
|  
|-
|-
| Users
| Users
| [[MDN/Kuma/Features/UserMetrics|User metrics]]
| [[MDN/Kuma/Features/UserMetrics|User metrics]]
|  
| P2
|
| TBD
|  
|  
|-
|-
| Users
| Users
| [[MDN/Kuma/Features/UserDashboard|User dashboard]]
| [[MDN/Kuma/Features/UserDashboard|User dashboard]]
|
| P3
| 1.5
| TBD
|  
|  
|-
|-
Line 322: Line 343:
| [[MDN/Kuma/Features/DemoTags|Demo tags]]
| [[MDN/Kuma/Features/DemoTags|Demo tags]]
|  
|  
| 2.0
| TBD
|  
|  
|-
|-
Line 328: Line 349:
| [[MDN/Kuma/Features/DemoSharing|Demo sharing]]
| [[MDN/Kuma/Features/DemoSharing|Demo sharing]]
|  
|  
| 2.0
| TBD
|  
|  
|-
|-
Line 334: Line 355:
| [[MDN/Kuma/Features/DemoJSFiddle|Demo JSFiddle integration]]
| [[MDN/Kuma/Features/DemoJSFiddle|Demo JSFiddle integration]]
|
|
| 2.0
| TBD
|  
|  
|-
|-
Line 340: Line 361:
| [[MDN/Kuma/Features/ContentCleanup|Content cleanup]]
| [[MDN/Kuma/Features/ContentCleanup|Content cleanup]]
|  
|  
| 1.4
| July 2012
|  
|  
|-
|-
Line 346: Line 367:
| [[MDN/Kuma/Features/URLNapcespaces|URL namespaces]]
| [[MDN/Kuma/Features/URLNapcespaces|URL namespaces]]
|  
|  
| 1.4
| July 2012
|  
|  
|-
|-
Line 352: Line 373:
| [[MDN/Kuma/Features/Redirects|Redirects]]
| [[MDN/Kuma/Features/Redirects|Redirects]]
|  
|  
| 1.4
| July 2012
|  
|  
|-
|-
Line 358: Line 379:
| [[MDN/Kuma/Features/AppAccess|Allow apps to access docs]]
| [[MDN/Kuma/Features/AppAccess|Allow apps to access docs]]
|  
|  
| 2.0
| TBD
|  
|  
|-
|-
Line 364: Line 385:
| [[MDN/Kuma/Features/SelectionAsDefinition|Mark selection as definition]]
| [[MDN/Kuma/Features/SelectionAsDefinition|Mark selection as definition]]
|  
|  
| 2.0
| TBD
|  
|  
|-
|-
|}
|}


== Development ==
= Kuma User's resources =
 
* [https://developer.mozilla.org/Project:en/Getting_started_with_Kuma Getting started with Kuma]
=== Scrum ===
* [https://developer.mozilla.org/Project:en/Introduction_to_KumaScript Introduction to KumaScript]
The Kuma team will be using Scrum to manage development. Please see the [[Scrum|Scrum page]] and [[Scrum/Guide|Scrum Guide]] for more information about using Scrum.
 
After evaluating a number of Scrum tools, the team decided that it would be easiest to use Buzilla to manage Scrum stories and artifacts. However, the team wants to make an effort to adopt Scrum principles in how they file and track bugs/stories in Bugzilla. To help with that, here is a proposal of how we will use Bugzilla and potentially create a new UI layer to manage development.
 
=== Milestones ===
 
* 1.0 - March 31 (staging)
** [http://bit.ly/gjzr2o Bugzilla buglist]
** [http://bit.ly/kumabasecamp Basecamp project]
** MDN apps => kitsune fork
*** <strike>clone https://github.com/jsocol/kitsune/tree/next ('next' branch)</strike>
*** <strike>push to github 'kuma'</strike>
**** https://github.com/mozilla/kuma
*** <strike>disable kitsune apps</strike>
*** <strike>move MDN 0.9.3 apps into kuma</strike>
*** <strike>create 'mdn' branch for 0.9.x dev</strike>
** <strike>capture deki users into django</strike>
** <strike>add kuma to hudson</strike>
*** https://hudson.mozilla.org/job/kuma/
** create a kuma-stage server [https://bugzilla.mozilla.org/show_bug.cgi?id=636576 it bug 636576]
** [[MDN/MDNv1/AcceptanceTests|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
 
= Artifacts and Progress =
 
* [http://bit.ly/kuma-product-backlog Product backlog (all remaining features)]
* Kuma 0.9.8
** Goal:
** [http://bit.ly/kuma-098-backlog-luke Luke], [http://bit.ly/kuma-098-backlog-les Les], [http://bit.ly/kuma-098-backlog-craig Craig], [http://bit.ly/kuma-098-backlog-unassigned Unassigned])
canmove, Confirmed users
1,953

edits