MDN/Archives/Kuma: Difference between revisions

From MozillaWiki
< MDN‎ | Archives
Jump to navigation Jump to search
(Replaced content with "Category:Delete")
m (Reverted edits by Jrooksjr (talk) to last revision by Aspivak)
Line 1: Line 1:
[[Category:Delete]]
= Launch Update =
Kuma launched August 3, 2012.
This page is now an archive of the pre-launch process
 
= 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.
 
== 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 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
 
= 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==
 
    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
 
See the '''[[MDN/Milestones|MDN Milestones]]''' page for a detailed roadmap and release schedule.
 
==Testing==
 
We are ramping up testing as we approach the launch of Kuma!
* [[MDN/Kuma/Test Weekend May 2012|Informal test weekend: Friday, May 11 through Sunday, May 13]]
* [[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'''
* Address: https://bugzilla.mozilla.org/buglist.cgi?quicksearch=Kuma&list_id=334028
* Purpose: Assign tasks and track resolutions.
 
'''Submitting bugs'''
 
* Please use this [http://mzl.la/mdn-bug Bug template].
 
== Features ==
 
=== Background ===
 
* [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.
 
* 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/NXsamRPw1U etherpad from Luke+Jay+James meeting]
* Other stuff
**[https://wiki.mozilla.org/MDN MDN programs and projects] - home for everything related to the Mozilla Developer Network
**[http://docs.google.com/View?id=dd59g5wx_146dxd5j3fd 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)
**[https://wiki.mozilla.org/Support/Kitsune Kitsune roadmap and requirements] - home for everything related to the next version of SUMO
**[http://docs.google.com/Doc?docid=0AVD_Sn4rUI7VYWg5cXA2ajhkMmc0XzEzZnh3eHhrYzQ&hl=en 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)
 
=== New MDN IA ===
 
* [http://etherpad.mozilla.com:9000/3J3IIP2xZt URL paths/structure]
 
=== MDN 1.0 PRD ===
 
A draft of the MDN 1.0 PRD lists most of the features that are needed to start the migration away from Deki. The document includes a list of features and their priorities.
 
* [http://bit.ly/mdn10prd MDN 1.0 PRD]
* [http://etherpad.mozilla.com:9000/kumafeatureslist Kuma Feature List]
 
=== Kitsune and overlap with SUMO ===
 
The documents below outline requirement overlap in SUMO and the MDN. We will collaborate with the SUMO development team to understand what is available in the Kitsune codebase and work through our requirements to build a solid foundation for the MDN website based on the Django framework.
 
* [https://spreadsheets.google.com/ccc?key=0AqPOgw3oBI8ldFRLd3JtOFdFclR1cGpXZHJLemR6YUE&authkey=CNSbyV4&hl=en#gid=2 Notes and Luke's dev analysis]
* [http://etherpad.mozilla.org:9000/NXsamRPw1U Etherpad from the Luke/Jay/James meeting]
 
= Development =
=== 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.
 
{| class="fullwidth-table sortable" style="width: 825px"
|-
| style="font-weight: bold; background: #DDD; width: 70px" | Component
| style="font-weight: bold; background: #DDD; " | Feature
| style="font-weight: bold; background: #DDD; width: 25px;" | Rank
| style="font-weight: bold; background: #DDD; " | Release
| style="font-weight: bold; background: #DDD; " | Notes
|-
| Wiki
| [[MDN/Kuma/Features/Editing|Editing]]
| P1
| July 2012
|
|-
| Wiki
| [[MDN/Kuma/Features/Templates|Templates]]
| P2
| July 2012
|
|-
| Wiki
| [[MDN/Kuma/Features/EditorialTools|Editorial tools]]
| P3
| July 2012
| some features
|-
| Wiki
| [[MDN/Kuma/Features/CodeEmbedding|Code embedding]]
| P3
| July 2012
|
|-
| Wiki
| [[MDN/Kuma/Features/Commenting|Commenting]]
| P4
| TBD
|
|-
| Wiki
| [[MDN/Kuma/Features/FileAttachments|File attachments]]
| P2
| July 2012
|
|-
| Wiki
| [[MDN/Kuma/Features/PrintAndExport|Print and export]]
| P4
| TBD
|
|-
| Search
| [[MDN/Kuma/Features/CategoryFilters|Category filter]]
| P2
| TBD
|
|-
| Search
| [[MDN/Kuma/Features/LocalizationFilter|Localization filter]]
| P3
| TBD
|
|-
| Search
| [[MDN/Kuma/Features/ExternalSearchResults|External search results]]
| P5
| TBD
|
|-
| Search
| [[MDN/Kuma/Features/ImprovedSearchRelevancy|Improved search relevancy]]
| P3
| TBD
|some features available in July
|-
| Search
| [[MDN/Kuma/Features/TagFilter|Tag filter]]
| P3
| TBD
|
|-
| Localization
| [[MDN/Kuma/Features/Localization/ChangeTracking|Change tracking for en-US]]
|
| July 2012
|
|-
| Localization
| [[MDN/Kuma/Features/Localization/RequestQueue|Localization request queue]]
|
| July 2012
| some features pushed to post-launch
|-
| Localization
| [[MDN/Kuma/Features/Localization/Dashboard|Localization dashboard]]
| P3
| TBD
|
|-
| Localization
| [[MDN/Kuma/Features/MetricsByLanguage|Metrics by language]]
| P3
| TBD
|
|-
| Localization
| [[MDN/Kuma/Features/LocalizedTags|Localized tags and categories]]
| P3
| TBD
|
|-
| Localization
| [[MDN/Kuma/Features/PhraseTranslation|Phrase translation service]]
| P4
| TBD
|
|-
| Localization
| [[MDN/Kuma/Features/LocalizationAssociations|Maintain association between localizations]]
| P1
| July 2012
|
|-
| Content Management
| [[MDN/Kuma/Features/DeleteAndRestore|Delete and restore]]
|
| July 2012
| Restore function post-launch
|-
| Content Management
| [[MDN/Kuma/Features/ComparePages|Compare two versions of a page]]
| P2
| July 2012
|
|-
| Content Management
| [[MDN/Kuma/Features/ReadOnly|Mark pages, subtrees, etc. as read-only]]
| P3
| TBD
|
|-
| Content Management
| [[MDN/Kuma/Features/DocMetrics|Metrics for doc activity]]
| P1
| July 2012
|
|-
| Content Management
| [[MDN/Kuma/Features/BatchProcessing|Queries and batch processing of docs]]
| P2
| TBD
| some features in July 2012
|-
| Content Management
| [[MDN/Kuma/Features/Endorse|Endorse or bump articles]]
| P4
| TBD
|
|-
| Engagement
| [[MDN/Kuma/Features/TweetButton|"Tweet this" button]]
| P4
| TBD
|
|-
| Engagement
| [[MDN/Kuma/Features/Rating|Rating system]]
| P4
| TBD
|
|-
| Engagement
| [[MDN/Kuma/Features/ArticlePromotionWidgets|Article promotion widgets]]
| P3
| TBD
|
|-
| Site Admin
| [[MDN/Kuma/Features/TagManagement|Tag management]]
| P2
| TBD
| some features in July
|-
| Site Admin
| [[MDN/Kuma/Features/TalkUserTags|No tags for talk or user pages]]
| P3
| TBD
|
|-
| Site Admin
| [[MDN/Kuma/Features/RSSFeeds|RSS feeds]]
| P2
| July 2012
| only for edits in first release
|-
| Site Admin
| [[MDN/Kuma/Features/UserManagement|User management]]
| P1
| July 2012
|
|-
| Site Admin
| [[MDN/Kuma/Features/SiteAnnouncements|Site-wide announcements]]
| P2
| July 2012
|
|-
| Site Admin
| [[MDN/Kuma/Features/CustomizeCSS|Easily customize CSS]]
| P2
| TBD
|
|-
| Site Admin
| [[MDN/Kuma/Features/AdminPanelLogs|Logs in the admin panel]]
| P2
| July 2012
|
|-
| Site Admin
| [[MDN/Kuma/Features/HTTPBrowsing|HTTP browsing]]
| P3
| TBD
|
|-
| Users
| [[MDN/Kuma/Features/UserAuthentication|User authentication]]
| P1
| July 2012
|
|-
| Users
| [[MDN/Kuma/Features/UserProfile|User profile]]
| P3
| TBD
|
|-
| Users
| [[MDN/Kuma/Features/UserMetrics|User metrics]]
| P2
| TBD
|
|-
| Users
| [[MDN/Kuma/Features/UserDashboard|User dashboard]]
| P3
| TBD
|
|-
| Demos
| [[MDN/Kuma/Features/DemoTags|Demo tags]]
|
| TBD
|
|-
| Demos
| [[MDN/Kuma/Features/DemoSharing|Demo sharing]]
|
| TBD
|
|-
| Demos
| [[MDN/Kuma/Features/DemoJSFiddle|Demo JSFiddle integration]]
|
| TBD
|
|-
| Migration
| [[MDN/Kuma/Features/ContentCleanup|Content cleanup]]
|
| July 2012
|
|-
| Migration
| [[MDN/Kuma/Features/URLNapcespaces|URL namespaces]]
|
| July 2012
|
|-
| Migration
| [[MDN/Kuma/Features/Redirects|Redirects]]
|
| July 2012
|
|-
| API
| [[MDN/Kuma/Features/AppAccess|Allow apps to access docs]]
|
| TBD
|
|-
| API
| [[MDN/Kuma/Features/SelectionAsDefinition|Mark selection as definition]]
|
| TBD
|
|-
|}
 
= Kuma User's resources =
* [https://developer.mozilla.org/Project:en/Getting_started_with_Kuma Getting started with Kuma]
* [https://developer.mozilla.org/Project:en/Introduction_to_KumaScript Introduction to KumaScript]

Revision as of 00:35, 24 October 2014

Launch Update

Kuma launched August 3, 2012. This page is now an archive of the pre-launch process

Introduction

"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 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

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

   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

See the MDN Milestones page for a detailed roadmap and release schedule.

Testing

We are ramping up testing as we approach the launch of Kuma!

Bugzilla

Submitting bugs

Features

Background

  • UserVoice: Feedback on the current MDN website.
  • Localization: We need to review and see what is possible based on the requests of localizers around the world.
  • Kuma related requirements/notes
  • 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)

New MDN IA

MDN 1.0 PRD

A draft of the MDN 1.0 PRD lists most of the features that are needed to start the migration away from Deki. The document includes a list of features and their priorities.

Kitsune and overlap with SUMO

The documents below outline requirement overlap in SUMO and the MDN. We will collaborate with the SUMO development team to understand what is available in the Kitsune codebase and work through our requirements to build a solid foundation for the MDN website based on the Django framework.

Development

Scrum

The Kuma team will be using Scrum to manage development. Please see the Scrum page and 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 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 feature EtherPad, the MDN 1.0 PRD, and the MDN / SUMO Shared Components PRD), and as such is fairly comprehensive.

Component Feature Rank Release Notes
Wiki Editing P1 July 2012
Wiki Templates P2 July 2012
Wiki Editorial tools P3 July 2012 some features
Wiki Code embedding P3 July 2012
Wiki Commenting P4 TBD
Wiki File attachments P2 July 2012
Wiki Print and export P4 TBD
Search Category filter P2 TBD
Search Localization filter P3 TBD
Search External search results P5 TBD
Search Improved search relevancy P3 TBD some features available in July
Search Tag filter P3 TBD
Localization Change tracking for en-US July 2012
Localization Localization request queue July 2012 some features pushed to post-launch
Localization Localization dashboard P3 TBD
Localization Metrics by language P3 TBD
Localization Localized tags and categories P3 TBD
Localization Phrase translation service P4 TBD
Localization Maintain association between localizations P1 July 2012
Content Management Delete and restore July 2012 Restore function post-launch
Content Management Compare two versions of a page P2 July 2012
Content Management Mark pages, subtrees, etc. as read-only P3 TBD
Content Management Metrics for doc activity P1 July 2012
Content Management Queries and batch processing of docs P2 TBD some features in July 2012
Content Management Endorse or bump articles P4 TBD
Engagement "Tweet this" button P4 TBD
Engagement Rating system P4 TBD
Engagement Article promotion widgets P3 TBD
Site Admin Tag management P2 TBD some features in July
Site Admin No tags for talk or user pages P3 TBD
Site Admin RSS feeds P2 July 2012 only for edits in first release
Site Admin User management P1 July 2012
Site Admin Site-wide announcements P2 July 2012
Site Admin Easily customize CSS P2 TBD
Site Admin Logs in the admin panel P2 July 2012
Site Admin HTTP browsing P3 TBD
Users User authentication P1 July 2012
Users User profile P3 TBD
Users User metrics P2 TBD
Users User dashboard P3 TBD
Demos Demo tags TBD
Demos Demo sharing TBD
Demos Demo JSFiddle integration TBD
Migration Content cleanup July 2012
Migration URL namespaces July 2012
Migration Redirects July 2012
API Allow apps to access docs TBD
API Mark selection as definition TBD

Kuma User's resources

Retrieved from "https://wiki.allizom.org/index.php?title=MDN/Archives/Kuma&oldid=1027804"