From 2006605e24aa58a1d28b87e9a45224dd613d6bd1 Mon Sep 17 00:00:00 2001 From: Reggie Riser Date: Tue, 21 Feb 2017 14:55:51 -0500 Subject: [PATCH] A few cleanups: 1) Fixed common.py references (now called base.py), 2) Made URLs consistent in pointing to dev Django docs as well as https, (#1037) --- docs/developing-locally.rst | 2 +- docs/project-generation-options.rst | 2 +- {{cookiecutter.project_slug}}/config/settings/base.py | 4 ++-- .../config/settings/production.py | 8 ++++---- {{cookiecutter.project_slug}}/docs/docker_ec2.rst | 2 +- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/developing-locally.rst b/docs/developing-locally.rst index 6c84ca3c..8aae8f0b 100644 --- a/docs/developing-locally.rst +++ b/docs/developing-locally.rst @@ -50,7 +50,7 @@ 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 +.. _configure your email backend: https://docs.djangoproject.com/en/dev/topics/email/#smtp-backend In development you can (optionally) use MailHog_ for email testing. MailHog is built with Go so there are no dependencies. To use MailHog: diff --git a/docs/project-generation-options.rst b/docs/project-generation-options.rst index c2b14e87..abedb4aa 100644 --- a/docs/project-generation-options.rst +++ b/docs/project-generation-options.rst @@ -25,7 +25,7 @@ version [0.1.0] The starting version number for your project. timezone [UTC] - Used in the common settings file for the `TIME_ZONE` value. + Used in the base settings file for the `TIME_ZONE` value. use_whitenoise [y] Whether to use WhiteNoise_ for static file serving. diff --git a/{{cookiecutter.project_slug}}/config/settings/base.py b/{{cookiecutter.project_slug}}/config/settings/base.py index f3f4251d..055da6f5 100644 --- a/{{cookiecutter.project_slug}}/config/settings/base.py +++ b/{{cookiecutter.project_slug}}/config/settings/base.py @@ -12,7 +12,7 @@ from __future__ import absolute_import, unicode_literals import environ -ROOT_DIR = environ.Path(__file__) - 3 # ({{ cookiecutter.project_slug }}/config/settings/common.py - 3 = {{ cookiecutter.project_slug }}/) +ROOT_DIR = environ.Path(__file__) - 3 # ({{ cookiecutter.project_slug }}/config/settings/base.py - 3 = {{ cookiecutter.project_slug }}/) APPS_DIR = ROOT_DIR.path('{{ cookiecutter.project_slug }}') # Load operating system environment variables and then prepare to use them @@ -28,7 +28,7 @@ if READ_DOT_ENV_FILE: env_file = str(ROOT_DIR.path('.env')) print('Loading : {}'.format(env_file)) env.read_env(env_file) - print('The .env file has been loaded. See common.py for more information') + print('The .env file has been loaded. See base.py for more information') # APP CONFIGURATION # ------------------------------------------------------------------------------ diff --git a/{{cookiecutter.project_slug}}/config/settings/production.py b/{{cookiecutter.project_slug}}/config/settings/production.py index a6615fca..1763096d 100644 --- a/{{cookiecutter.project_slug}}/config/settings/production.py +++ b/{{cookiecutter.project_slug}}/config/settings/production.py @@ -62,8 +62,8 @@ MIDDLEWARE = ['opbeat.contrib.django.middleware.OpbeatAPMMiddleware', ] + MIDDLE # SECURITY CONFIGURATION # ------------------------------------------------------------------------------ -# See https://docs.djangoproject.com/en/1.9/ref/middleware/#module-django.middleware.security -# and https://docs.djangoproject.com/ja/1.9/howto/deployment/checklist/#run-manage-py-check-deploy +# See https://docs.djangoproject.com/en/dev/ref/middleware/#module-django.middleware.security +# and https://docs.djangoproject.com/en/dev/howto/deployment/checklist/#run-manage-py-check-deploy # set this to 60 seconds and then to 518400 when you can prove it works SECURE_HSTS_SECONDS = 60 @@ -82,7 +82,7 @@ X_FRAME_OPTIONS = 'DENY' # SITE CONFIGURATION # ------------------------------------------------------------------------------ # Hosts/domain names that are valid for this site -# See https://docs.djangoproject.com/en/1.10/ref/settings/#allowed-hosts +# See https://docs.djangoproject.com/en/dev/ref/settings/#allowed-hosts ALLOWED_HOSTS = env.list('DJANGO_ALLOWED_HOSTS', default=['{{cookiecutter.domain_name}}', ]) # END SITE CONFIGURATION @@ -278,7 +278,7 @@ RAVEN_CONFIG = { # A sample logging configuration. The only tangible logging # performed by this configuration is to send an email to # the site admins on every HTTP 500 error when DEBUG=False. -# See http://docs.djangoproject.com/en/dev/topics/logging for +# See https://docs.djangoproject.com/en/dev/topics/logging for # more details on how to customize your logging configuration. LOGGING = { 'version': 1, diff --git a/{{cookiecutter.project_slug}}/docs/docker_ec2.rst b/{{cookiecutter.project_slug}}/docs/docker_ec2.rst index 444172c4..1c015b90 100644 --- a/{{cookiecutter.project_slug}}/docs/docker_ec2.rst +++ b/{{cookiecutter.project_slug}}/docs/docker_ec2.rst @@ -31,7 +31,7 @@ The Docker compose tool (previously known as `fig`_) makes linking these contain ... docker-compose.yml -Each component of your application would get its own `Dockerfile`_. The rest of this example assumes you are using the `base postgres image`_ for your database. Your database settings in `config/common.py` might then look something like: +Each component of your application would get its own `Dockerfile`_. The rest of this example assumes you are using the `base postgres image`_ for your database. Your database settings in `config/base.py` might then look something like: .. _Dockerfile: https://docs.docker.com/reference/builder/ .. _base postgres image: https://registry.hub.docker.com/_/postgres/