Keith Callenberg
081711ee63
minor correction in working directory in docs
2021-08-09 16:29:09 -04:00
Grant McLean
9c3b0bcca0
revise previous patch to conform to project style for RST links
2021-06-09 15:39:35 +12:00
Grant McLean
05249e9954
Fix link format in developing-locally.rst
...
Link was markdown format - changed to RST.
2021-06-09 10:33:13 +12:00
Bruno Alla
9e7320ea1b
Merge branch 'master' into fix_upgrade_py39
...
# Conflicts:
# README.rst
# {{cookiecutter.project_slug}}/.gitlab-ci.yml
# {{cookiecutter.project_slug}}/compose/local/django/Dockerfile
# {{cookiecutter.project_slug}}/compose/production/django/Dockerfile
2021-04-08 18:43:54 +01:00
PJ Hoberman
b980db9f62
Adding local celery instructions to developing-locally
2021-01-30 13:55:06 -07:00
areski
a1d551d067
Update from Python3.8 to Python3.9
2021-01-26 16:13:27 +01:00
Fabian Affolter
4b9002d7db
Fix formatting
2020-11-14 22:10:36 +01:00
Bruno Alla
b592003f87
Fix snippet in documentation
2020-07-25 14:37:54 +01:00
Andrew Chen Wang
8bdef165a8
Fixed local async command in docs
2020-06-16 23:51:21 -04:00
Jonathan Thompson
393526bc47
Clarify the installation steps for local setup
...
Added a link to Cookiecutter as a prerequisite.
Added an installation command for cookiecutter-django.
Added a command for git init. The precommit install fails unless you have a git repo.
This should make it easier for a newcomer to get things configured.
2020-04-27 02:31:46 +00:00
Bruno Alla
c4e4bea31b
Merge branch 'master' into async
2020-04-16 09:43:38 +01:00
Andrew-Chen-Wang
cc099ae941
Edited docs for local running async
2020-04-13 11:26:09 -04:00
Ernesto Cedeno
0cdf60ceac
Change Python version to 3.8
2020-03-29 19:55:27 +02:00
leollon
4a194c6966
Add pre-commit for the generated project. ( #2171 )
2019-10-29 22:48:39 +08:00
Nicolas Stefani
acb72cb84c
Updated docs
2019-09-29 21:48:04 -03:00
Bruno Alla
dd32fb2c13
Tweak formatting in docs
2019-06-18 20:50:17 +01:00
keithjeb
aea5c807f6
Change eager celery setting in local Docker ( #1945 )
...
[//]: # (Thank you for helping us out: your efforts mean great deal to the project and the community as a whole!)
[//]: # (Before you proceed:)
[//]: # (1. Make sure to add yourself to `CONTRIBUTORS.rst` through this PR provided you're contributing here for the first time)
[//]: # (2. Don't forget to update the `docs/` presuming others would benefit from a concise description of whatever that you're proposing)
## Description
[//]: # (What's it you're proposing?)
Added a note around CELERY_TASK_ALWAYS_EAGER = True in docker config for local development. This causes tasks to be executed on the 'main' thread rather than by the workers. I understand why that might be desirable, but thought it worth calling out incase (like me) it makes people think something is broken.
## Rationale
[//]: # (Why does the project need that?)
Ease of use/troubleshooting
## Use case(s) / visualization(s)
[//]: # ("Better to see something once than to hear about it a thousand times.")
2019-03-02 13:51:30 +00:00
Afrowave
53940411cc
EDITED the developing locally doc.
2018-11-20 00:06:54 +03:00
Bruno Alla
0de682f22d
Update database setup instructions for developing locally
2018-09-29 12:30:19 +01:00
Bruno Alla
46ab5aefc7
Use a more specific version of python for venv
2018-09-16 20:04:50 +01:00
Bruno Alla
6dd64ddd53
Update documentation for bare metal local development
...
- Mention the need for Redis if Celery is selected
- Link to PostgreSQL & Redis download pages
- Detail better how to set the environment
- Improve internal links using Sphinx' :ref
- Remove unused link
2018-09-15 21:23:06 +01:00
Bruno Alla
078c1fb8ba
Remove references to Compass as it's no longer required
...
Also it's no longer maintained: https://github.com/Compass/compass
2018-09-01 11:43:07 +01:00
Bruno Alla
ebcd5ec098
Cleanup outdated references to Grunt - fixes #1721
2018-08-30 20:34:56 +01:00
Nikita P. Shupeyko
a31f5090d1
Update the docs
2018-03-09 21:55:30 +03:00
Reggie Riser
2006605e24
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 )
2017-02-21 11:55:51 -08:00
kappataumu
eeae4e8978
Move e-mail backend setup info for docker to the appropriate section
2016-06-13 12:56:12 +00:00
kappataumu
bfe72d5276
Point to the docs instead of repeating everything
2016-06-13 12:32:13 +00:00
kappataumu
1e47efac8a
Fix reST issues
2016-06-13 12:32:13 +00:00
Antonia Blair
b100f2a00d
Tweak env vars section of docs ( #611 )
...
Thanks for the PR! 🍡
2016-06-11 20:50:25 -07:00
Audrey Roy Greenfeld
87845bd817
Temp quick fixes to improve developing-locally doc
2016-06-03 15:31:50 -07:00
shireenrao
e8b0baf36c
Update developing locally docs on how to setup .env file
...
Even though a link to the django-environ is there, it may help to see that .env file needs to be present for it to work.
2016-05-23 22:37:47 -04:00
Jannis Gebauer
24d75ebe45
resolved merge conflicts
2016-05-22 20:18:08 +02:00
Daniel Roy Greenfeld
7b24c19ce5
Fix #524
2016-05-09 21:12:34 -07:00
Fabio C. Barrioneuvo da Luz
2b878fcf36
replace occurrences of readthedocs.org to readthedocs.io
2016-05-09 17:18:58 -03:00
shireenrao
8cbe97bb9f
Added a comment on how to use mailhog
...
As somebody new to mailhog, I was a confused on how to use it. I first assumed, it was going to be used by the django app itself. After reading more on the internet I found it needed to be executed outside of the django application.
2016-05-09 14:33:21 -04:00
Audrey Roy Greenfeld
fb59c5117b
More repo_name -> project_slug cleanup
2016-04-20 11:41:17 -07:00
Krzysztof Szumny
8a682818b3
Additional conditions with use_docker
2016-04-18 23:25:49 +02:00
Krzysztof Szumny
7c4135fb45
grunt and documentation cleanning
2016-04-18 23:03:41 +02:00
Daniel Sears
57aed057cc
Added an explanation of how to define the DATABASE_URL environment variable.
2016-01-08 15:40:19 -08:00
areski
c2e79902bf
Bump Django to v1.9
2015-12-09 13:33:17 +01:00
Thomas Korrison
a304e466a5
Update developing-locally.rst
2015-12-01 14:25:55 +00:00
Thomas Korrison
917bf99ea3
Update developing-locally.rst
2015-12-01 14:09:50 +00:00
Tom Atkins
3316a3b023
Fix merge conflict in README.rst
2015-11-18 11:16:25 +00:00
Daniel Roy Greenfeld
d022bc89f0
Update developing-locally.rst
2015-10-07 09:51:18 -07:00
Daniel Roy Greenfeld
e031ed8e6f
Fixing database configuration.
2015-10-07 09:50:21 -07:00
Daniel Roy Greenfeld
698c990cbd
Refactored the Docker docs and added indexes.
2015-09-18 14:26:29 -07:00
Daniel Roy Greenfeld
27b59b460c
Beginning of reorganization of documentation per #335
...
* Created top-level docs Sphinx directory
* Moved development instructions out of /README.rst and into /docs/
2015-09-18 09:22:55 -07:00
