The MediaWiki Site

Warning

Tue Apr 1, 2017:

The Mediawiki site has be deprecated in favor of another documentation source.

DO NOT USE WIKI.ZENOSS.ORG ANY LONGER!

Creating an Account

  • First go to http://wiki.zenoss.org and click on Create Account
    • Go through all the steps, and validation.
  • Afterwards, request that a wiki administrator add you to the editors list

Adding a New Wiki Page (Deprecated)

Adding a New Release Form (Deprecated)

On the wiki page for your ZP, go to the Create/Edit Releases area. Click on the ‘+’ button to add a new release section. (See also the notes on Publish the ZenPack Egg)

To summarize,

  • Set the version and Git Tag/SHA1: as the release tag.

  • Enter the release date

  • Enter any magjor changes in bullet format

  • Select the Compatible entries

  • Skip the Incompatibles

  • Enter any Requires items (Use known links if possible)

  • Download URL: For commercial ZP’s only

    • For an OpenSource ZP, your SHA1/Tag (above) must match that of your git release so that MediaWiki can auto-identify and build the target.
    • For proprietery ZP, you have to link it with our https://zenoss.leapfile.net/

Editing an existing ZenPack Page

Always use the [Edit with Form] link at the top, and the associated text box at the bottom. Otherwise you’ll end up changing meta-data that is set by the form part.

Note

  • In general, your ZenPack should have a README.mediawiki file in the root folder that is the exact content of that text box. This way we have a backup and a way that developers and QA can review your docs.
  • Typically, the README.mediawiki goes through the same type of review process as all other code.