#233: Commented-out example add-ons in buildout.cfg

Contents

1. Definitions
2. Motivation
3. Assumptions
4. Proposal
5. Implementation
6. Deliverables
7. Risks
8. Progress log
9. Participants

Proposed by

limi

Seconded by

stevem

Proposal type

Process

Repository branch

trunk

State

being-discussed

Definitions

 

Motivation

1. It will provide a quick way to enable frequently used add-ons.
2. It will show how to use buildout to add products.
   

Assumptions

 

Proposal

1. Determination of a list of candidate products, both functionality and development.
2. Development of clear, unambiguous text for comments.
3. Implementation in the major installers and ZopeSkel's P3 template.
   

Implementation

See the Unified Installer trunk, particularly http://svn.plone.org/svn/plone/Installers/UnifiedInstaller/trunk/standalone_template/buildout.cfg for initial implementation.

Hopefully, the framework team will help pick products. Good candidates could include:

Commonly used products:
    Products.LinguaPlone
    Products.CacheSetup
    Products.PloneHelpCenter
    Products.PloneFormGen

Commonly used development tools:
    Products.Clouseau
    Products.DocFinderTab
    plone.reload

I propose as minimum criteria that the products are available as eggs and have stable releases.

Deliverables

 

Risks

Including add-ons in buildout, even in comments, may create a presumption that the products are part of Plone and that we're committed to their maintenance.

The risk may be mitigated with careful choice of add-ons and good language.

Progress log

Sample implementation in http://svn.plone.org/svn/plone/Installers/UnifiedInstaller/trunk/standalone_template/buildout.cfg

Participants

Steve McMahon

Alex Limi

Joel Burton

Jon Stahl