From 1e47efac8a00bb5a1b853248dfbed54308f5e629 Mon Sep 17 00:00:00 2001 From: kappataumu Date: Mon, 13 Jun 2016 12:05:43 +0000 Subject: [PATCH 1/3] Fix reST issues --- docs/developing-locally.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/developing-locally.rst b/docs/developing-locally.rst index 02c9baf49..6f5b282c1 100644 --- a/docs/developing-locally.rst +++ b/docs/developing-locally.rst @@ -51,15 +51,17 @@ Setup your email backend django-allauth sends an email to verify users (and superusers) after signup and login (if they are still not verified). To send email you need to `configure your email backend`_ .. _configure your email backend: http://docs.djangoproject.com/en/1.9/topics/email/#smtp-backend + {% if cookiecutter.use_docker == 'y' %} -In development you can (optionally) use MailHog_ for email testing. MailHog is added as docker-container. To use MailHog:: +In development you can (optionally) use MailHog_ for email testing. MailHog is added as docker-container. To use MailHog: 1. Make sure, that ``mailhog`` docker container is up and running 2. Open your browser and go to ``http://127.0.0.1:8025`` .. _Mailhog: https://github.com/mailhog/MailHog/ + {% else %} -In development you can (optionally) use MailHog_ for email testing. MailHog is built with Go so there are no dependencies. To use MailHog:: +In development you can (optionally) use MailHog_ for email testing. MailHog is built with Go so there are no dependencies. To use MailHog: 1. `Download the latest release`_ for your operating system 2. Rename the executable to ``mailhog`` and copy it to the root of your project directory @@ -69,6 +71,7 @@ In development you can (optionally) use MailHog_ for email testing. MailHog is b .. _Mailhog: https://github.com/mailhog/MailHog/ .. _Download the latest release: https://github.com/mailhog/MailHog/releases + {% endif %} Alternatively simply output emails to the console via: ``EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'`` From bfe72d52767ee04c4eadefdafdf1c7560e863f65 Mon Sep 17 00:00:00 2001 From: kappataumu Date: Mon, 13 Jun 2016 12:12:32 +0000 Subject: [PATCH 2/3] Point to the docs instead of repeating everything --- docs/developing-locally.rst | 18 ++---------------- 1 file changed, 2 insertions(+), 16 deletions(-) diff --git a/docs/developing-locally.rst b/docs/developing-locally.rst index 6f5b282c1..196d03bfa 100644 --- a/docs/developing-locally.rst +++ b/docs/developing-locally.rst @@ -81,20 +81,6 @@ In production basic email configuration is setup to send emails with Mailgun_ **Live reloading and Sass CSS compilation** -If you'd like to take advantage of live reloading and Sass / Compass CSS compilation you can do so with the included Grunt task. +If you’d like to take advantage of live reloading and Sass / Compass CSS compilation you can do so with a little bit of `prep work`_. -Make sure that nodejs_ is installed. Then in the project root run:: - - $ npm install - -.. _nodejs: http://nodejs.org/download/ - -Now you just need:: - - $ grunt serve - -The base app will now run as it would with the usual ``manage.py runserver`` but with live reloading and Sass compilation enabled. - -To get live reloading to work you'll probably need to install an `appropriate browser extension`_ - -.. _appropriate browser extension: http://feedback.livereload.com/knowledgebase/articles/86242-how-do-i-install-and-use-the-browser-extensions- +.. _prep work: https://cookiecutter-django.readthedocs.io/en/latest/live-reloading-and-sass-compilation.html From eeae4e8978d9c5eecce76edb55b924368612eea5 Mon Sep 17 00:00:00 2001 From: kappataumu Date: Mon, 13 Jun 2016 12:56:12 +0000 Subject: [PATCH 3/3] Move e-mail backend setup info for docker to the appropriate section --- docs/developing-locally-docker.rst | 8 ++++++++ docs/developing-locally.rst | 10 ---------- 2 files changed, 8 insertions(+), 10 deletions(-) diff --git a/docs/developing-locally-docker.rst b/docs/developing-locally-docker.rst index 7a11c7a4e..4c9ccac83 100644 --- a/docs/developing-locally-docker.rst +++ b/docs/developing-locally-docker.rst @@ -183,4 +183,12 @@ You may need to add the following to your css in order for the django-debug-tool } +Setup your email backend +~~~~~~~~~~~~~~~~~~~~~~~~ +In development you can (optionally) use MailHog_ for email testing. MailHog is added as docker-container. To use MailHog: + +1. Make sure, that ``mailhog`` docker container is up and running +2. Open your browser and go to ``http://127.0.0.1:8025`` + +.. _Mailhog: https://github.com/mailhog/MailHog/ diff --git a/docs/developing-locally.rst b/docs/developing-locally.rst index 196d03bfa..6c84ca3c2 100644 --- a/docs/developing-locally.rst +++ b/docs/developing-locally.rst @@ -52,15 +52,6 @@ django-allauth sends an email to verify users (and superusers) after signup and .. _configure your email backend: http://docs.djangoproject.com/en/1.9/topics/email/#smtp-backend -{% if cookiecutter.use_docker == 'y' %} -In development you can (optionally) use MailHog_ for email testing. MailHog is added as docker-container. To use MailHog: - -1. Make sure, that ``mailhog`` docker container is up and running -2. Open your browser and go to ``http://127.0.0.1:8025`` - -.. _Mailhog: https://github.com/mailhog/MailHog/ - -{% else %} In development you can (optionally) use MailHog_ for email testing. MailHog is built with Go so there are no dependencies. To use MailHog: 1. `Download the latest release`_ for your operating system @@ -72,7 +63,6 @@ In development you can (optionally) use MailHog_ for email testing. MailHog is b .. _Mailhog: https://github.com/mailhog/MailHog/ .. _Download the latest release: https://github.com/mailhog/MailHog/releases -{% endif %} Alternatively simply output emails to the console via: ``EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'`` In production basic email configuration is setup to send emails with Mailgun_