Author Topic: Proposals for Improvements to the Extensions ecosystem (Read 1721 times)

Upperholme · September 09, 2014, 02:28:39 am

This was prompted by this thread (http://forum.civicrm.org/index.php/topic,33923.0.html) which highlighted the potential for problems when upgrading with one or more extensions installed.

The extensions ecosystem has grown significantly over the last year or two, and it is fair to assume that this will continue to expand and thrive, which is excellent and in my view a strong indicator of the health of the CiviCRM community. In order to best support this developing area and make life easier for users, I'd like to propose the following changes:

It is currently difficult to identify extensions at https://civicrm.org/extensions based on their compatibility with different versions of CiviCRM. I therefore propose that the listing mechanism be developed to enable users to filter based on compatibility (I assume its a Drupal View). At the same time extension authors are encouraged to specify which versions of CiviCRM their code is compatible with.
As an extension user it can be unclear how to go about seeking support or locating documentation for extensions. Many extension authors will include a readme file as part of their release, and many will advise going to the forum for support. However, once on the forum it is not at all clear where one might go to seek support for a given extension. There are child boards under the 'Using CiviCRM' section that cover things like 'Using Joomla extensions' and 'Using Drupal Webform Integration' alongside child boards about specific core components, and there's also a board in the main 'Community' section (rather than the 'Support' section) called 'Extensions'. Whilst this board is notionally about writing extensions it has clearly also been used as the focal point for support requests for some extensions (I've done so myself in the absence of anywhere more suitable or obvious).
I therefore propose that the forum be reorganised to provide a specific board within the 'Support' area, called Extensions, to be a focal point for community support for all Extensions. As the usage and volume of support posts grows over time, it may be sensible to create child boards for the more popular extensions (indeed Coleman's excellent Drupal webform integration module is a prime example, where the existing board could be moved intact).
With respect to documentation for extensions, I further propose that we set up a new section within the wiki to provide a central home for documentation for all Extensions. Extension authors will be encouraged to create pages within this section for their particular extension/s. Community members can then collectively develop and enhance the documentation for extensions as part of the broader documentation effort.

I'd like to encourage comments, criticisms and improvements to these three proposals. I'm happy to lead on the implementation of these changes (perhaps with a bit of help) which I believe will add value to Extensions as a whole, facilitating wider uptake and usage, and improving the user-friendliness of CiviCRM as a whole.

Thanks for reading.
Graham

Michael McAndrew · September 10, 2014, 06:44:08 am

Quote

It is currently difficult to identify extensions at https://civicrm.org/extensions based on their compatibility with different versions of CiviCRM. I therefore propose that the listing mechanism be developed to enable users to filter based on compatibility (I assume its a Drupal View). At the same time extension authors are encouraged to specify which versions of CiviCRM their code is compatible with.

The version compatibility information is in there - except it is tied to the release of the extension, not to the extension (see for example https://civicrm.org/extensions/cividiscount-extension). There are two node types for releases

Quote

Extension Release (CiviCRM-native)
Extension Release (CiviCRM-native) is used to capture information about each release version of Extensions that are native extensions to CiviCRM. In order for the distribution module to pickup that Extension, an Extension Release needs to exist and be approved.

Quote

Extension Release (CMS)
Extension Release (CMS) is used to capture information about each release version of Extensions that are native extensions to CMS like Drupal, Joomla or Wordpress. They are not included in the automatic distribution system.

So not sure how easy it would be to do, but I reckon possible to add a views filter. The best thing to do would be to experiment changing the view on our test site http://www-test.civicrm.org and when you have it working, we can export and import the view into production.

Quote

a specific board within the 'Support' area, called Extensions, to be a focal point for community support for all Extensions

This sounds like a good idea. Moving Coleman's board there is probably a good idea. Might want to talk to Coleman about it. And the same goes for lcdweb and Joomla extensions (not really sure what that is). I've given you admin permissions to the forum so that you can do that. Would be great if you could add decent descriptions as well as titles to the boards.

Quote

With respect to documentation for extensions, I further propose that we set up a new section within the wiki to provide a central home for documentation for all Extensions.

We've (Mathieu, Nicolas and I) talked in the past about the best place for extension documentation, as part of an overhall to our documentation efforts. That doesn't seem to be moving very fast at the moment and creating a section within the wiki is probably a good interim measure.

Michael McAndrew · September 10, 2014, 06:46:00 am

One thought you might want to consider - it is probably easy to get confused between extensions documentation (documentation about specific extesions) and extensions documentation (documentation on how to create an extension)

Upperholme · September 10, 2014, 08:40:29 am

Thanks for the feedback.

The test domain is asking me for login in order to get to the site. Is that the same as my current civicrm.org login?

Michael McAndrew · September 12, 2014, 02:52:59 am

nope - i'll send it to you

Coleman Watts · October 06, 2014, 05:51:08 pm

This issue has been open forever https://issues.civicrm.org/jira/browse/INFRA-95
I'll send Kasia a reminder.

Upperholme · October 06, 2014, 11:25:31 pm

And it looks like petednz may have dealt with it.

sonicthoughts · October 29, 2014, 09:16:51 am

Would you consider a vote / mini review (since most people are already authenticated.) Would be very helpful. Automated stats are nice, but alone are not very reliable.

JoeMurray · November 11, 2014, 05:44:52 am

FWIW, the agenda for tomorrow's partner call includes a discussion of the Extensions ecosystem. Would be good to bring ideas forward there.

Cheers,
Joe

JohnFF · November 13, 2014, 12:09:52 pm

Good suggestions.

The main thing that I want is a mandatory 'usage' field in the documentation. My extension that cleans email addresses operates without user intervention. My extension that cleans phone numbers makes the user do the leg work. I've seen a few extensions where I was unclear how - if at all - they should be operated.

Upperholme · November 19, 2014, 03:10:48 am

Quote from: JoeMurray on November 11, 2014, 05:44:52 am

FWIW, the agenda for tomorrow's partner call includes a discussion of the Extensions ecosystem. Would be good to bring ideas forward there.

Joe, I wasn't able to participate in the call - pretty late in the evening for my brain. Are there any notes recorded from the discussion that I could look at, or maybe you (or indeed anyone that did take part) could post anything relevant in this thread?

Best wishes

JoeMurray · November 19, 2014, 11:26:17 am

https://docs.google.com/a/jmaconsulting.biz/spreadsheets/d/1hU1uUu3TfqWwz1fKbpds-YmHfBnebq9IJbXP2VpUO44/edit#gid=1087672135 has a second sheet with the minutes, and is shared with the members of the Partners' List.

petednz · November 19, 2014, 11:33:45 am

Joe's reply was made while i was fwd'ing the link

CiviCRM Community Forums (archive)

News:

Author Topic: Proposals for Improvements to the Extensions ecosystem (Read 1721 times)

Upperholme

Proposals for Improvements to the Extensions ecosystem

Michael McAndrew

Re: Proposals for Improvements to the Extensions ecosystem

Michael McAndrew

Re: Proposals for Improvements to the Extensions ecosystem

Upperholme

Re: Proposals for Improvements to the Extensions ecosystem

Michael McAndrew

Re: Proposals for Improvements to the Extensions ecosystem

Coleman Watts

Re: Proposals for Improvements to the Extensions ecosystem

Upperholme

Re: Proposals for Improvements to the Extensions ecosystem

sonicthoughts

Re: Proposals for Improvements to the Extensions ecosystem

JoeMurray

Re: Proposals for Improvements to the Extensions ecosystem

JohnFF

Re: Proposals for Improvements to the Extensions ecosystem

Upperholme

Re: Proposals for Improvements to the Extensions ecosystem

JoeMurray

Re: Proposals for Improvements to the Extensions ecosystem

petednz

Re: Proposals for Improvements to the Extensions ecosystem