Aldryn django CMS

Aldryn django CMS is an opinionated django CMS setup bundled as an Aldryn addon for the Divio Cloud.

Aldryn addons are wrappers around Python packages, that take care of their installation and configuration.

Python/Django compatibility

This version of Aldryn django CMS installs and is compatible with:

Get started

See the Divio Developer Handbook for general information on using the platform. Start with the tutorial if this is new to you.

Recommended

To use Aldryn django CMS, create a new Aldryn django CMS project on the Divio Control Panel. This project type includes Aldryn django CMS along with some additional packages in order to set up a ready-to-go project. The additional packages include Django Filer, a default set of plugins, Django Parler and others.

Alternative option

Alternatively, you can install Aldryn django CMS in an Aldryn Divio Django project, but in this case, you will need to install Django Filer and other components included in the Divio django CMS base project yourself.

How to

Contribute

This is a an open-source project. We'd be delighted to receive your feedback in the form of issues and pull requests. Before submitting your pull request, please review our contribution guidelines.

We're grateful to all contributors who have helped create and maintain this package. Contributors are listed at the contributors section.

Run tests

Run tests by executing:

virtualenv env
source env/bin/activate
pip install -r tests/requirements.txt
python setup.py test

Release a new version

Each Aldryn django CMS release uses the version number of the corresponding django CMS release, with an extra number (starting with 0) to indicate the version of Aldryn django CMS for that release. So for example version 3.7.4.2 of Aldryn django CMS is the third Aldryn django CMS version that installs django CMS 3.7.4.

Repeat the following until you are satisfied that the Addon works as expected:

1. Ensure that you are working in a clean local directory, and that no unwanted compiled or other files are present.
2. Update the CHANGELOG.rst as and if required.
3. Update the version number in __init__.py and setup.py.
4. Use the Divio CLI to verify and upload the addon (see How to update an existing addon to the the Alpha channel.
5. Test the Addon on the Divio platform.

Once satisfied:

1. Push to Git, make a pull request, ask for a review, obtain approval, squash and merge.
2. Tag with the version number.
3. Move the release to the Beta or Stable channel as appropriate, and add a note to the Changelog field, on Divio.
4. Notify the team via Slack.