Support/Kitsune/KB/Implementation: Difference between revisions

From MozillaWiki
< Support‎ | Kitsune‎ | KB
Jump to navigation Jump to search
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Challenges ==
== UNSOLVED design decisions ==
* SHOWFOR
* How do we migrate articles
** How to meet good UX with a reasonable implementation
** How do we migrate SHOWFOR?
* Approved vs staging copies
** How do we migrate templates? (formerly known as dynamic content)
** Edits on staging copies pile on top of each other. Any flexibility in order of approval?
* How do we implement templates?
*** Looks like always must approve every edit prior to approve a certain one.
* How do we get accurate views into [http://people.mozilla.com/~chowse/drop/sumo/kb/v7/toolbox/01_reviewer_dashboard.png dashboard]?
* Media library
** Upload progress
** Exterminator?


== Static pages ==
== SOLVED design decisions ==
* Home page, live chat page
* How do we handle multiple unreviewed revisions?
** Home page contains list of articles/categories
** '''Solution:'''
** Home pare should have a section for posting urgent messages without requiring a push.
*** approving or rejecting revisions does not change previous or ulterior revisions
 
*** each revision needs to be approved or rejected individually
== Articles ==
*** the latest (by time of creation) approved revision is the one publicly visible
* Editable
* How do we handle micro VS macro showfor?
* Lockable
** '''Solution:'''
* KB articles VS contributor articles
*** Macro showfor is per-heading. E.g. |== Some text (SHOWFOR: mac, linux) ==|
* Tags/Categories -- allows for "related articles"
**** The content until the next heading shows on mac and linux, but not on windows
* Localized
*** Micro showfor uses internal link syntax. E.g. <nowiki>[[Showfor:linux=Ctrl|windows=Ctrl|mac=Cmd]]</nowiki>
* Exportable (?)
* Could have an introduction/summary field, for use in search results
* Review of changes with approve/deny
** Save progress without asking for review
** Mark articles as ready for review
** Message author of edit on approval/denial
** Emails contain links to approve/deny
* Mark edits as spam
== Localization ==
* Mark translations as out of date
* Side by side translation
* In progress translation locks out others
== Versioning (History) ==
* Diffs
* Comparison
* Revert to version
* Delete versions
 
Above reminds me a lot of Wordpress
 
== Wiki support ==
* SHOWFOR
* templates
* Editable by section
* Reordering of sections
* Table of contents on/off
* List of contributors to article
* Special syntax as defined [[Support/Kitsune/KB/Priorities#Editing here]]
== Discussion ==
* Articles can be discussed in forums
== Misc ==
* media upload
** media library (listing uploaded screenshots and videos)
** videos offer quick links to embed
** flickr-like notes for images on mouseover
* screencast support
** "step by step text instructions"
** skip to next step in video
* print stylesheet for articles
* manually set related articles
* include article in other article
== Search ==
* match on user's OS/fx version
* keywords for articles
== Polls ==
* attached to article
* attached to section of article? does this require wiki syntax?
== Localization Dashboard ==
== Contributor Dashboard ==
== Contributor/User Sidebar ==
== Administration ==
* add/remove articles
* add/remove categories/tags
* add/remove permissions for users/groups

Latest revision as of 00:28, 27 August 2010

UNSOLVED design decisions

  • How do we migrate articles
    • How do we migrate SHOWFOR?
    • How do we migrate templates? (formerly known as dynamic content)
  • How do we implement templates?

SOLVED design decisions

  • How do we handle multiple unreviewed revisions?
    • Solution:
      • approving or rejecting revisions does not change previous or ulterior revisions
      • each revision needs to be approved or rejected individually
      • the latest (by time of creation) approved revision is the one publicly visible
  • How do we handle micro VS macro showfor?
    • Solution:
      • Macro showfor is per-heading. E.g. |== Some text (SHOWFOR: mac, linux) ==|
        • The content until the next heading shows on mac and linux, but not on windows
      • Micro showfor uses internal link syntax. E.g. [[Showfor:linux=Ctrl|windows=Ctrl|mac=Cmd]]