Difference between revisions of "Form:ZenPack"

From Zenoss Wiki
Jump to: navigation, search
(Replaced content with "__NOTOC__ <noinclude> {{note}} The ZenPack Catalog has moved to its new home at https://www.zenoss.com/product/zenpacks.")
Line 2: Line 2:
{{note}} The ZenPack Catalog has moved to its new home at https://www.zenoss.com/product/zenpacks.
{{note}} The ZenPack Catalog has moved to its new home at https://www.zenoss.com/product/zenpacks.
You can use [https://www.zenoss.com/product/zenpacks/community-creation this form] to request updates to the [https://www.zenoss.com/product/zenpacks ZenPack Catalog].
{{note}} The ZenPack Catalog has moved to its new home at https://www.zenoss.com/product/zenpacks.
You can use [https://www.zenoss.com/product/zenpacks/community-creation this form] to request updates to the [https://www.zenoss.com/product/zenpacks ZenPack Catalog].
== How to add a ZenPack to the Directory ==
To add a new ZenPack to the directory, enter the ZenPack name below. Note that you should ''not'' use the Python name, such as <tt>ZenPacks.zenoss.OpenVZ</tt>, as the page name. Instead, use an easy-to-read name, like "OpenVZ".
It is also not necessary to add the word "ZenPack" to your name. ZenPacks are automatically added to the special MediaWiki ''ZenPack'' namespace to indicate that they are ZenPacks. The URL to reach your new ZenPack page will be <tt>http://wiki.zenoss.org/ZenPack:zpname</tt>.
== Add a New ZenPack ==
{{#forminput:form=ZenPack|query string=namespace=ZenPack}}
{{note|The auto-build system is currently online! Add a proper Source URI for GitHub and appropriate releases with tags, and your ZenPack will be auto-built :)}}
=== Names and Organizations ===
When you add a name to the Author or Maintainer fields, this form will automatically link to the User:name page. Every Wiki user has their own User page that they can create and maintain which is accessible at http://wiki.zenoss.org/User:username.
Similarly, any Organization you specify will link to a corresponding regular page at http://wiki.zenoss.org/orgname. This allows you to create a regular wiki page for your organization.
<div id="wikiPreview" style="display: none; padding-bottom: 25px; margin-bottom: 25px; border-bottom: 1px solid #AAAAAA;"></div>
{{{for template|ZenPack}}}
{| class="formtable"
! Summary of ZenPack:
| {{{field|Summary|}}}{{#info:Specify a short summary of the ZenPack's functionality here.}}
! Author(s): (full name or wiki username)
| {{{field|Author|values from namespace=User|list}}}{{#info:Specify the ZenPack author's name here. Multiple authors can be specified, separated by commas. Will autocomplete using wiki usernames.}}
! Maintainer(s): (full name or wiki username)
| {{{field|Maintainer|values from namespace=User|list}}} {{#info:Specify the current maintainer of the ZenPack. Multiple names can be specified, separated by commas. Will autocomplete using wiki usernames.}}
! Organization:
| {{{field|Organization|values from category=Organizations}}} {{#info:Specify the organization, if any, that authored this ZenPack. Note that you can create your own Organization on this wiki -- add it to the Organizations category.}}
! License:
| {{{field|License|values from category=Licenses|input type=dropdown|default="GNU General Public License, Version 2, or later"}}} {{#info:Specify the license under which this ZenPack is released. Most ZenPacks are released under the GNU General Public License, Version 2, or later.}}
! ZenPack Python name:
| {{{field|ZenPack name}}} Note: {{#info:Specify the "Python name" here, such as ZenPacks.zenoss.OpenVZ}}
! Homepage (typically, web-browesable GitHub URL):
| {{{field|Homepage}}} {{#info:Specify a URL where you can get more information. You can leave it blank if you plan to use this wiki page as your ZenPack's home page.}}
! Documentation URL (often old Jive site page):
| {{{field|Documentation URL}}} {{#info:Link to detailed documentation, although you are encouraged to make the wiki page the new home for your ZenPack}}
! Source URI:
| {{{field|Source URI}}} Paste the "git read-only" GitHub link for your repo (that someone would use to clone)
! Restart:
| {{{field|Restart}}} Commands to restart the ZenPack after install. Defaults to <tt>zenoss restart</tt>. Separate multiple commands by a semicolon.
! Flavor:
| {{{field|Flavor|values from property=Flavor|input type=dropdown|default="free"}}}
! Internal Tags:
| {{{field|Tags|list|property=ClassTag|input type=checkboxes}}}
''Zenoss wiki maintainers are currently using Internal Tags to identify ZenPacks that need updating. Leave as-is.''
== Create/Edit Releases ==
This is the part where you create specific versions of Your ZenPack. Click "Add release" below to add a new release. Please place more recent releases at the top -- releases can be ordered by dragging the "gripper" arrow to the right. Also, don't include an exhaustive history of releases -- just include the most recent version(s) that would be of interest to various Zenoss users (typically, this means most recent 1-2 3.x-compatible releases and most recent 1-2 4.x-compatible releases.)
For each release, specify a:
# Version, ie. '''2.1.0'''
# Source Tag/SHA1 - ''optional'' - the tag in GitHub that you used for this version, or the SHA1 hash of the top commit (to be used for our auto-build system)
# Compatible with - specify the products you have tested your ZenPack against. Use the auto-complete values that pop up. (Start typing "Zen...")
# Requires - specify other ZenPacks that this release depends upon, if any. Use auto-complete values.
{{{field|Releases|holds template}}}
== Device Monitoring ==
In this section, specify the devices that this ZenPack monitors.
{{{field|Devices|holds template}}}
== Application Monitoring ==
In this section, specify the applications that this ZenPack monitors.
{{{field|Applications|holds template}}}
== Application Integration ==
In this section, specify any application that this ZenPack integrates with, by doing things such as exporting Zenoss data or events.
{{{field|Integrations|holds template}}}
== [[Data Quality and Completeness Audits]] ==
This section is used for performing periodic audits of the correctness and completeness of data related to this ZenPack. Most people can safely skip this section.
{{{field|DataAudits|holds template}}}
{{{end template}}}
{{{for template|Release|multiple|add button text=Add release|embed in field=ZenPack[Releases]}}}
'''Version:''' {{{field|Version|size=10|input type=text|mandatory}}}
'''Git Tag/SHA1:''' {{{field|Tag|size=32|input type=text}}} {{#info:Specify the git tag or SHA1 to use for building this release. This tag or SHA1 will need to exist in your source repository listed above.}}
'''Release date:''' {{{field|Release date|input type=datepicker|date format=dd M yy}}}
'''Summary of changes:'''
'''Compatible with:''' {{{field|Compatible with|mandatory|values from category=Compatibility Levels|list|input type=listbox}}}
'''Incompatible with:''' {{{field|Incompatible with|values from category=Compatibility Levels|list|input type=listbox}}}
'''Requires:''' {{{field|Requires|values from namespace=ZenPack|list}}}
'''Enhances:''' {{{field|Enhances|values from namespace=ZenPack|list}}}
'''Download URL:''' (used for commercial ZenPacks only) {{{field|Download URL|input type=text|Download URL}}}
{{{end template}}}
{{{for template|Device|multiple|add button text=Add device|embed in field=ZenPack[Devices]}}}
'''Manufacturer:''' {{{field|Manufacturer|mandatory}}}
'''Model:''' {{{field|Model|mandatory}}}
{{{end template}}}
{{{for template|Application|multiple|add button text=Add monitored app|embed in field=ZenPack[Applications]}}}
'''Product Name:''' {{{field|Product Name|mandatory}}}
'''Version:''' {{{field|Version}}}
{{{end template}}}
{{{for template|Integration|multiple|add button text=Add integration|embed in field=ZenPack[Integrations]}}}
'''Product Name:''' {{{field|Product Name|mandatory}}}
'''Version:''' {{{field|Version}}}
{{{end template}}}
{{{for template|DataAudit|multiple|add button text=Add Audit|embed in field=ZenPack[DataAudits]}}}
=== Author and Date ===
Define who performed the audit (specify wiki username) and the date upon which the audit was performed.
;'''Author:''' {{{field|Author|values from namespace=User|default=current user}}}
;'''Date:''' {{{field|Release date|input type=datepicker|date format=dd M yy}}}
=== Compatibility Audit ===
Below, define the most recent commercial and/or Open Source release of Zenoss that this ZenPack was tested against. Leave blank if no compatibility testing was performed as part of the audit. Once compatibility testing has been performed, be sure to update the compatibility information for each release, and check the ''ReleaseCompatibility'' Audit Item (checkbox) to indicate that the release compatibility information has been updated.
==== Commercial Compatibility ====
;Compatibility Level: {{{field|CommercialCompatibility|values from category=Commercial Compatibility Levels|input type=dropdown}}}
;Release Version (i.e. "<tt>4.2.4</tt>"): {{{field|CommercialRelease}}}
;PatchLevel (RPS version): {{{field|CommercialPatchLevel}}}
==== Open Source Compatibility ====
;Compatibility Level: {{{field|OpenSourceCompatibility|values from category=Open Source Compatibility Levels|input type=dropdown}}}
;Release Version (i.e. "<tt>4.2.4</tt>"): {{{field|OpenSourceRelease}}}
;PatchLevel (RPS version): {{{field|OpenSourcePatchLevel}}}
=== Audit Items ===
Below, select the various ZenPack metadata (documentation, etc.) that you have audited, and whether they are complete or incomplete (if possible, update all incomplete items so that they are complete.) You can also explicitly mark what items you ''haven't'' audited. For definitions of each Audit Item, see the [[Data Quality and Completeness Audits]] page.
==== Audit: Complete  and Correct ====
;Audited items - Complete: {{{field|CompleteItems|list|values from property=AuditItem|input type=checkboxes}}}
==== Audit: Incomplete and/or Incorrect ====
;Audited items - Incomplete: {{{field|IncompleteItems|list|values from property=AuditItem|input type=checkboxes}}}
==== Audit: Not Audited This Time ====
;Not Audited: {{{field|NotAuditedItems|list|values from property=AuditItem|input type=checkboxes}}}
{{{end template}}}
== Documentation ==
Enter documentation or extended information for the ZenPack below.  If you need to add more complex wikitext, use the "Edit" button after saving this page, and enter your wiki text at the bottom. This allows you to provide rich documentation content for your ZenPack.
{{{standard input|free text|rows=20}}}
{{{for template|ZenPackFooter}}}
{{{end template}}}
{{{standard input|summary}}}
{{{standard input|minor edit}}} {{{standard input|watch}}}
{{{standard input|save}}} {{{standard input|preview}}} {{{standard input|changes}}} {{{standard input|cancel}}}

Latest revision as of 21:59, 21 October 2019

Bulbgraph.png Note: The ZenPack Catalog has moved to its new home at https://www.zenoss.com/product/zenpacks.