Ticket #280 (new Bug)

Opened 5 months ago

Last modified 1 month ago

New documentation (developer): build very simple example plugins

Reported by: matt Assigned to:
Priority: major Milestone: DigitalVibes
Component: Documentation Version:
Keywords: Cc:

Description (Last modified by matt)

It's hard to write a good developer documentation. Examples are easier to understand and to maintain. We will write a number of plugins, that each uses one feature of Piwik:

  • ExampleDBAccess
  • ExampleFeedburner
  • ExampleWidget
  • ExampleEditMenu

Then we would:

  • build a wiki page listing all the Example plugins
  • print their quick description
  • link to their source code

Examples of other open source project plugin documentation

Ideas of simple useful plugins

  • "You have X websites and Y users registered in Piwik. You are using Piwik A.B version."
  • "Featured user" that randomly picks a use case from our use case base.
  • "Piwik has been downloaded N times."

Technical notes:

  • content loaded from piwik.org via highly cached proxy pages
  • if piwik.org is down, should not affect loading time of dashboard
  • have one widget for general purpose content (Piwik has been downloaded X times)

Change History

10/10/08 17:11:01 changed by matt

  • summary changed from Developer documentation: build very simple example plugins to New documentation (developer): build very simple example plugins.

10/10/08 18:38:42 changed by matt

  • description changed.

10/10/08 19:05:15 changed by matt

  • description changed.

10/10/08 19:07:35 changed by matt

  • owner changed.
  • component changed from Core to Documentation.