Repository files navigation

django CMS Versioning requires that you have a django CMS 4.0 (or higher) project already running and set up.

Run:

pip install djangocms-versioning

Adddjangocms_versioning to your project'sINSTALLED_APPS.

Run:

python -m manage migrate djangocms_versioningpython -m manage create_versions --userid <user-id-of-migration-user>

to perform the application's database migrations and (only if you have an existing database) add version objectsneeded to mark existing versions as draft.

Versioning integration instructions are available indocs/versioning_integration.rst

An example implementation can be found here:

• djangocms_versioning/test_utils/polls/cms_config.py
• djangocms_versioning/test_utils/polls/models.py

To run all the tests the only thing you need to do is run:

pip install -r tests/requirements.txtpython setup.py test

We maintain documentation under thedocs folder using rst format.

To generate the HTML documentation you will need to installsphinx (pip install sphinx) andgraphviz (as per your operating system's package management system). You can then generate the docs using the following command:

Run:

cd docs/make html

This should generate all html files from rst documents under docs/_build folder, which can be browsed.

Because this is a an open-source project, we welcome everyone toget involved in the project andreceive a reward for their contribution.Become part of a fantastic community and help us make django CMS the best CMS in the world.

We'll be delighted to receive yourfeedback in the form of issues and pull requests. Before submitting yourpull request, please review ourcontribution guidelines.

The project makes use of git pre-commit hooks to maintain code quality.Please follow the installation steps to getpre-commitsetup in your development environment.

We're grateful to all contributors who have helped create and maintainthis package. Contributors are listed at thecontributorssection.

One of the easiest contributions you can make is helping to translate this addon onTransifex.To update transifex translation in this repo you need to download thetransifex cli and runtx pull from the repo's root directory. After downloading the translationsdo not forget to run thecompilemessages management command.