cookiecutter-django/docs/troubleshooting.rst

Troubleshooting
=====================================

This page contains some advice about errors and problems commonly encountered during the development of Cookiecutter Django applications.

#. ``project_slug`` must be a valid Python module name or you will have issues on imports.

#. ``jinja2.exceptions.TemplateSyntaxError: Encountered unknown tag 'now'.``: please upgrade your cookiecutter version to >= 1.4 (see `#528`_)

#. Internal server error on user registration: make sure you have configured the mail backend (e.g. Mailgun) by adding the API key and sender domain

#. New apps not getting created in project root: This is the expected behavior, because cookiecutter-django does not change the way that django startapp works, you'll have to fix this manually (see `#1725`_)

#. .. include:: mailgun.rst

.. _#528: https://github.com/pydanny/cookiecutter-django/issues/528#issuecomment-212650373
.. _#1725: https://github.com/pydanny/cookiecutter-django/issues/1725#issuecomment-407493176
adding troubleshooting doc 2016-06-03 21:55:44 +03:00			`Troubleshooting`
			`=====================================`

			`This page contains some advice about errors and problems commonly encountered during the development of Cookiecutter Django applications.`

			#. ``project_slug`` must be a valid Python module name or you will have issues on imports.

Document server error when missing Mailgun config Fixes #789 2018-03-27 01:31:10 +03:00			#. ``jinja2.exceptions.TemplateSyntaxError: Encountered unknown tag 'now'.``: please upgrade your cookiecutter version to >= 1.4 (see `#528`_)
Group environment variables by the corresponding directories (#1295) * Update generated project's .gitignore * Post-gen gitignore .env/ and .env * Fix linesep between gitignored entries * Persist `.env/*/` files into cookiecutter-django's VCS * Rename .env/ to .envs/ * Reference the newly created .envs/*/. files in local.yml * Reference the newly created .envs/*/. files in production.yml * Delete .env.example * Refactor post-gen-project.py Closes #1299. * Implement production-dotenv-files-to-dotenv-file merge script * Create shared PyCharm Run Configuration for the automation script * Randomize POSTGRES_PASSWORD in ./envs/(.local\|.production)/.postgres * Default POSTGRES_PASSWORD and POSTGRES_USER to random values * Fix jinja linebreaks in local.yml * Spaces in production.yml * Fix post-merge leftovers & set DJANGO_ADMIN_URL automatically * Prettify here and there * Fix FileNotFoundError * Leave a TODO in post_gen_hook.py * Introduce keep_local_envs_in_vcs option * Remove envs when not opted for * Inline pre_gen_project.py if-condition * Get rid of PROJECT_DIR_PATH in post_gen_project.py * Clean up the docs * Match copyright notices * Document envs ins and outs 2018-03-08 15:56:15 +03:00
Document server error when missing Mailgun config Fixes #789 2018-03-27 01:31:10 +03:00			`#. Internal server error on user registration: make sure you have configured the mail backend (e.g. Mailgun) by adding the API key and sender domain`

Added help for startapp 2018-12-18 14:37:35 +03:00			#. New apps not getting created in project root: This is the expected behavior, because cookiecutter-django does not change the way that django startapp works, you'll have to fix this manually (see `#1725`_)

Add documentation about Mailgun setup fixes #1705 2019-03-27 00:36:38 +03:00			`#. .. include:: mailgun.rst`

Document server error when missing Mailgun config Fixes #789 2018-03-27 01:31:10 +03:00			`.. _#528: https://github.com/pydanny/cookiecutter-django/issues/528#issuecomment-212650373`
Added help for startapp 2018-12-18 14:37:35 +03:00			`.. _#1725: https://github.com/pydanny/cookiecutter-django/issues/1725#issuecomment-407493176`