ZenPacks and JSON API

1.  Updating ZenPack catalog

Posted 10-17-2017 10:13 AM
John,
I have just updated one of my community ZenPacks and wish to update it on the Catalog.  The wiki site  http://wiki.zenoss.org/ZenPack_Catalog  now says to contact you rather than providing the wiki form that we used to fill in.

How do I get the ZenPacks.skills-1st.WinSnmp ZenPack updated?

For anyone looking for it, there are now two branches, master and justPython, that you can find on github here - https://github.com/jcurry/ZenPacks.skills1st.WinSnmp   .  The master branch is the companion ZenPack to go with the briefing document.  The justPython branch has had all the COMMAND driven stuff stripped out to make it a more sensible production ZenPack.

Cheers,
Jane

------------------------------
Jane Curry
Skills 1st United Kingdom
jane.curry@skills-1st.co.uk
------------------------------


2.  RE: Updating ZenPack catalog

Posted 13 days ago
Hello @Jane. Apologies for not seeing this one but I noticed you did not tag me in the message. When addressing another member in this new platform you can use the @ symbol and type the first few letters of their name...chose their name...thus tagging them in the message. This alerts them that you are speaking to them directly.​​ Awesome feature.  You can also #Hashtag key words to improve search results which I know you see as just as much of a priority as I do.​

So...once you are ready to publish your ZenPack all you need to do is go to the Community ZenPack Creation page....complete the form and submit. We will review the details...help you add any additional information that would be useful to users and then publish to the Zenoss ZenPack Catalog. Exciting news is this month when we kick off the 2018 ZenPack Challenge which I can see you entering since you write so many fab ZenPacks. Please contact me directly with any questions. Happy to help!

Cheers!

JB​

------------------------------
John Boyle
Technology Partnerships & Community Manager
Zenoss
Austin TX
jboyle@zenoss.com
http://www.zenoss.com
------------------------------



3.  RE: Updating ZenPack catalog

Posted 13 days ago
Hi @John,
I see the new ZenPack creation page, but what about updating existing ZenPack entries, like my ZenPacks.skills-1st.WinSnmp ZenPack ?
Cheers,
Jane​

------------------------------
Jane Curry
Skills 1st United Kingdom
jane.curry@skills-1st.co.uk
------------------------------



4.  RE: Updating ZenPack catalog

Posted 12 days ago
@Jane That is a fabulous question and I have asked our solutions team the preferred update method for those members who are not submitting new #ZenPacks. What changes did you make to this #ZenPack and which versions does it work with???? ​​​Looking forward to hearing the details!!

JB

------------------------------
John Boyle
Technology Partnerships & Community Manager
Zenoss
Austin TX
jboyle@zenoss.com
http://www.zenoss.com
------------------------------



5.  RE: Updating ZenPack catalog

Posted 12 days ago
@John - have a look at the updates section here on github - https://github.com/jcurry/ZenPacks.skills1st.WinSnmp/tree/justPython

As in initial request, the master branch is the companion to a briefing paper; the justPython branch has been recently cleaned up for use in a more production environment.

Cheers,
Jane​

------------------------------
Jane Curry
Skills 1st United Kingdom
jane.curry@skills-1st.co.uk
------------------------------



6.  RE: Updating ZenPack catalog

Posted 10 days ago

@Jane for updates please use the same form as you would for a brand new ZenPack. All the details go to our team responsible for publishing and we can track the requests the same way as well as reach out if we need more details. Looks like a good update. URL again is: https://www.zenoss.com/product/zenpacks/community-creation​.

Cheers!

JB



------------------------------
John Boyle
Technology Partnerships & Community Manager
Zenoss
Austin TX
jboyle@zenoss.com
http://www.zenoss.com
------------------------------



7.  RE: Updating ZenPack catalog

Posted 7 days ago
Hi @John,
Surely you cannot be serious?  I have over 20 ZenPacks and you want me to enter all the details all over again if I update them?  This isn't going to encourage anyone to maintain their ZenPacks.  In the past, we simply used a form to add the details of the new release/version and the github reference, and it was added to the existing info.

I have just updated the ZenPacks.skills1st.WinSnmp in your form, as requested (20 minutes).  Might I suggest that, especially for new submitters of ZenPacks, it isn't very clear what information you want where and the form is designed more with the web maintainer in mind than the ZenPack submitter.

In particular, if this is the shop window for ZenPacks, then a structure for the main body description, would be helpful both to authors and readers.  I have done a quick bodge job with cut and paste from the existing ZenPack page (which appears to have gone through some updates by someone other than me in the past) but the structure I have in the README.rst on GitHub - https://github.com/jcurry/ZenPacks.skills1st.WinSnmp/   came from an earlier Zenoss-supplied template and would encourage best practices if the form supplied a similar outline.

Please consider a way to help those of us who have existing ZenPacks, to maintain them in a more light-weight manner and encourage new developers with a simple process.

Many thanks,
Jane​

------------------------------
Jane Curry
Skills 1st United Kingdom
jane.curry@skills-1st.co.uk
------------------------------



8.  RE: Updating ZenPack catalog

Posted 6 days ago

Thanks for your reply @Jane. Would love your feedback on preferred form inputs and process for updating. Please email me directly and I will work to simliplfy the process.​

Cheers!

JB



------------------------------
John Boyle
Technology Partnerships & Community Manager
Zenoss
Austin TX
jboyle@zenoss.com
http://www.zenoss.com
------------------------------



9.  RE: Updating ZenPack catalog

Posted 6 days ago
@John,
As above, a structure and template  for the main body description, as per the ZenPacks.skills1st.WinSnmp, would be the first thing to do.

The next thing to do is to rethink the "Title" and "URL" headings for each section under "Side Panel".  URL is often inappropriate; title is often the wrong word to use.  Perhaps you supply examples to be overwritten?

If you start with that and produce a mock-up then we can progress from there.  I suggest we keep the discussion here so other folk can contribute.

Cheers,
Jane​

------------------------------
Jane Curry
Skills 1st United Kingdom
jane.curry@skills-1st.co.uk
------------------------------



10.  RE: Updating ZenPack catalog

Posted 6 days ago
Edited by Jay Stanley 6 days ago
I am glad this information has finally been posted. Been waiting on it for sometime now.

I agree with Jane.

A few thoughts:

New ZenPacks:

  1. Pre-populated documentation form(s) with example information. Currently, I have a Word Doc that I use as a template for any new ZenPacks. It has every topic that needs to be covered and gives an example of the information that would be contained.
  2. Import feature. Building on the template idea above. It would be great if there was a MD template or something that could be populated and then uploaded. This way it could be kept in GIT with our ZenPacks and then easily updated and then uploaded during submission.
  3. Ability to add screen shots. Are we expected to host or find a 3rd party to host images for the documentation as well? Or create some library on the forums, then do the ZenPack submission?
  4. Submissions linked to community user account. Then allow for certain information to be pre-populated. (Like Author, Maintainer, Org, etc)
  5. Preview button, or a review information button that would take all the information entered and show you what the page would potentially look like.
  6. What team is responsible for reviewing submissions? What is the turn around time? What do they review? (Documentation, fact checking, link checking, code review, ZenPack testing?) Will submissions be denied?
  7. What is the difference between Title and Name fields?
  8. Add field for version of ZP and tested versions of Zenoss (ie: does this ZenPack work with 3.x, 4.x, 5.x, 6.x?)

Updating ZenPacks:
  1. A simpler process is needed for updating your own ZenPacks. There is no way I would want to repopulate this information each time I update a ZenPack. Some sort of capability to edit your own page would be nice. Even if the revision needs to be approved by a second person.
  2. A good example would be how easy it is to edit the old ZenPack pages on the wiki. The whole page can be edited or just sub-sections.

*Edit: I agree with keeping the discussion here, for others to contribute.


jstanley


11.  RE: Updating ZenPack catalog

Posted 6 days ago
@Jay & @Jane - Great inputs. Let me review these with our web developer who put the initial form together and size them up. Looking at Jason's list the only one I think I need to check on with the platform vendor is importing data from the community profile but that would make things faster.  - JB​​

------------------------------
John Boyle
Technology Partnerships & Community Manager
Zenoss
Austin TX
jboyle@zenoss.com
http://www.zenoss.com
------------------------------