Diff for "LEP/Wiki"

Not logged in - Log In / Register

Differences between revisions 4 and 5
Revision 4 as of 2011-05-22 22:46:03
Size: 2019
Editor: xaav
Comment:
Revision 5 as of 2011-05-22 23:49:55
Size: 2770
Editor: thumper
Comment:
Deletions are marked like this. Additions are marked like this.
Line 28: Line 28:
 * Each project should have its own wiki
Line 34: Line 35:
 * Page refreshless editing of wiki pages.
Line 38: Line 39:
 * Take too long to render pages
Line 56: Line 58:
 - This has always been what I thought -- [[LaunchpadHome:thumper]] <<DateTime(2011-05-22T23:49:55Z)>>

We should blacklist the "wiki" name as a series name, to allow the definition
of lp:project/wiki to refer to the wiki for a project.

There should be a way to branch the wiki, hack locally, and merge the wiki
back to Launchpad's version.

[[https://launchpad.net/wikkid|Wikkid]] was designed from the start to do
this. As the primary developer and maintainer of wikkid, I'd love to see it
used in Launchpad as it was the initial impetus to get it going -- [[LaunchpadHome:thumper]] <<DateTime(2011-05-22T23:49:55Z)>>

Wiki

A wiki to provide documentation and feature planning for launchpad projects.

Contact: https://launchpad.net/~xaav/+contactuser
On Launchpad: https://blueprints.launchpad.net/launchpad/+spec/wiki-hosting

As a Developer
I want a Wiki
so that Projects can provide documentation to their users and developers can plan features more easily.

Rationale

In 2008, a feature request was filed in the launchpad bug tracker. Since that time, it has been approximately 3+ years, and users have requested a wiki on launchpad. The bug now shows up as the hottest bug on the launchpad bug tracker. Yet, this feature has still not been completed.

A wiki would benefit all users, and complete launchpad. Right now, there is no place for documentation; a wiki would solve this issue. Right now, blueprints link to external wikis (Including this one!). Completing a wiki would remove most of the need for an external site, and if completed, may even eliminate the need for this wiki.

Stakeholders

Just look at https://bugs.launchpad.net/launchpad/+bug/240067#subscribers-direct

Constraints and Requirements

Must

  • Scale to millions of users.
  • Prevent XSS attacks and properly escape output.
  • Each project should have its own wiki

Nice to have

  • Use markdown or equivalent instead of just filtered HTML.
  • Render Wiki pages from bazaar branches (Specify which branch to render pages from)
  • Be able to edit pages via Web UI. (WMD Editor - Possible?)
  • Page refreshless editing of wiki pages.

Must not

  • Take too long to render pages

Out of scope

Subfeatures

Will use https://launchpad.net/wikkid

Success

How will we know when we are done?

When a collaborative wiki is implemented that provides an easy way to communicate information.

How will we measure how well we have done?

Thoughts?

URL should be http://wiki.launchpad.net/project-name/Wiki_page

  • - This has always been what I thought -- thumper 2011-05-22 23:49:55

We should blacklist the "wiki" name as a series name, to allow the definition of lp:project/wiki to refer to the wiki for a project.

There should be a way to branch the wiki, hack locally, and merge the wiki back to Launchpad's version.

Wikkid was designed from the start to do this. As the primary developer and maintainer of wikkid, I'd love to see it used in Launchpad as it was the initial impetus to get it going -- thumper 2011-05-22 23:49:55

LEP/Wiki (last edited 2011-06-21 14:53:00 by jml)