bobtemplates.cs

Templates for Plone projects by CodeSyntax


Keywords
web, plone, zope, skeleton, project
License
GPL-2.0
Install
pip install bobtemplates.cs==1.9.1

Documentation

https://travis-ci.com/codesyntax/bobtemplates.cs.svg?branch=master Coveralls Latest Version Documentation Status License

bobtemplates.cs

bobtemplates.cs provides a mr.bob template to generate packages for Plone projects using our customizations. This packages is based on bobtemplates.plone

Features

Package created with bobtemplates.cs use the current best-practices when creating an add-on.

Provided templates

  • cs_plone_volto_buildout
  • cs_plone_buildout
  • cs_migration
cs_plone_volto_buildout

This template provides a ready-to-use buildout template for Plone backends for Volto. It asks for a Plone version and configures the buildout with it.

The generated buildout provides configuration files for nginx and Apache, haproxy, varnish and logrotate.

It also creates cron jobs to pack your database and to restart the services when the server is rebooted.

cs_plone_buildout

This template provides a ready-to-use buildout template for Plone sites. It asks for a Plone version and configures the buildout with it.

The generated buildout provides configuration files for nginx and Apache, haproxy, varnish and logrotate.

It also creates cron jobs to pack your database and to restart the services when the server is rebooted.

cs_migration

This template adds some useful blueprints and a pipeline for a Transmogrifier based migration for Plone 5.

The provided pipeline will work with a collective.jsonify export out of the box.

We have been using the blueprints and the pipeline in several projects and found them very useful. To make the pipeline work correctly, you will need to adjust the created migration1.cfg file to provide the path of the export and adjust one or two parameters.

To get started with Transmogrifier, visit the training at https://training.plone.org/5/transmogrifier

You can run the migration from the command line, using the provided zopectl scripts, as follows. Inspect all the registered transmogrifier pipelines:

$ cd /path/to/your/buildout
$ ./bin/instance list_migrations

Run the selected pipeline:

$ cd /path/to/your/buildout
$ ./bin/instance run_migration my.package-step1

Compatibility

Add-ons created with bobtemplates.cs are tested to work in Plone 5 and Plone 5.1. They should also work with older versions but that was not tested. It should work on Linux, Mac and Windows.

Documentation

Full documentation for end users can be found in the "docs" folder.

Contribute

Support

If you are having issues, please let us know.