Commit Graph

379 Commits

Author SHA1 Message Date
Bruno Alla
8b4493365c Fix Sphinx warning 2021-11-24 21:09:42 +00:00
Bruno Alla
6219aa4549
Small formatting fixes to Deploy to PythonAnywhere page (#3432)
* Remove Jinja tags in Deploy to PythonAnywhere documentation

* Tweak formatting for deploy on PythonAnywhere documentation page
2021-11-24 18:12:22 +00:00
Bruno Alla
fda7b9e2cc Set docs theme to sphinx-rtd-theme 2021-11-22 21:31:29 +00:00
mpoli
145d65aeff
Bump Postgres to 13.5 12.9 11.14 10.19; add 14.1 (#3428) 2021-11-22 09:26:46 +00:00
Bruno Alla
9f359939a9
Upgrade JS dependencies and upgrade to node 16 (#3400) 2021-11-16 20:29:43 +00:00
Bruno Alla
5e99c7b54d
Fix wayback machine URL in docs
Fix #3223
2021-11-15 11:38:43 +00:00
pyup-bot
bc34320416 Update sphinx from 4.2.0 to 4.3.0 2021-11-10 12:18:51 -08:00
Bruno Alla
d43dd831ee Fix broken build for docs 2021-11-04 18:06:49 +00:00
Fábio C. Barrionuevo da Luz
3467fb8c02
Merge pull request #3363 from nthall/update-postgres-setup-link
use Wayback Machine to fix dead link for postgres user setup
2021-10-25 21:40:41 -03:00
Bruno Alla
b2d46296f0
Move repo under cookiecutter organisation (#3357) 2021-10-22 13:40:53 -07:00
Noah Hall
ea56c11028 use Wayback Machine to fix dead link for postgres user setup 2021-10-14 22:34:59 -04:00
Meraj
112c29d77b
Updated developing-locally-docker.rst
changed wrong hyperlink in Prerequisites section
2021-10-01 17:02:07 +03:30
Bruno Alla
8142af1e15
Merge pull request #3297 from tannart/patch-1
Update available postgres versions
2021-09-03 18:15:34 +01:00
Keith Callenberg
a4a6cbf90c
Fix several minor typos 2021-08-19 16:43:44 -04:00
Charlie Macfarlane Brodie
5529c44b16
Update available postgres versions
The listed versions in the documentation were out of sync with those given when running cookiecutter as recommended in the documentation.
2021-08-17 09:44:45 +01:00
Bruno Alla
872f690f94
Merge pull request #3268 from Mike97M/master
Add documentation for automating backups
2021-08-12 10:41:46 +02:00
Bruno Alla
1bddad0275
Merge pull request #3291 from keithcallenberg/patch-1
Add missing step to getting started locally in docs
2021-08-12 10:35:12 +02:00
Keith Callenberg
081711ee63
minor correction in working directory in docs 2021-08-09 16:29:09 -04:00
Abdul Qoyyuum
3dfb5d1564
Update developing-locally-docker.rst 2021-08-07 16:43:47 +01:00
Abdul Qoyyuum
370cefdf24
How to pre-commit in Docker Development
It is clear that pre-commit cannot work inside Docker containers and it can only work with git stored on the local machine since its not in a shared volume with the containers. Therefore, it should be noted that anyone who uses this cookicutter with pre-commit already generated by default in every project, should start using pre-commit into their general workflow.
2021-08-06 15:55:40 +01:00
Mike97M
e295ddb778
Backup - get container ID automatically from docker-compose
Backup documentation to show how to use "docker-compose -f local.yml ps -q postgres" to get the container ID instead of hard coding it.
2021-07-14 16:06:38 +03: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
Ray Besiga
e3c646f726
Shorthand for the official supported buildpack
Replacing the Github link with the Heroku shorthand defined for the officially supported buildpack.
2021-06-05 22:02:57 +03: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
Bruno Alla
7b92bc388d
Update deprecated scale command to up --scale
The scale command is deprecated: Use the up command with the `--scale` flag instead.
2021-01-28 10:46:03 +00: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
Andrew Chen Wang
72da0bfa9c
Fix docs service and add RTD support (#2920)
Co-authored-by: Andrew-Chen-Wang <Andrew-Chen-Wang@users.noreply.github.com>
Co-authored-by: Bruno Alla <browniebroke@users.noreply.github.com>
2020-11-04 17:17:02 +00:00
Arnav Choudhury
b064e09f12
Adding GitHub-Action CI Option (#2837) 2020-09-21 11:20:24 +01:00
Jelmer Draaijer
688739cb39 Add environment and traces_sample_rate keyword to sentry_sdk.init 2020-08-28 10:25:40 +02:00
Corey Garvey
4f72047446
Updating production path to be hidden folder 2020-08-19 15:40:13 +01:00
Demetris Stavrou
89420f2932
Update linters.rst
Related to #2744 issue.
2020-08-14 15:09:36 +03:00
Bruno Alla
cac78de485
Merge pull request #2664 from Afrowave/master 2020-08-14 08:16:22 +01:00
Jimmy Gitonga
ddcafff94f
Update docs/developing-locally-docker.rst
Co-authored-by: Bruno Alla <browniebroke@users.noreply.github.com>
2020-08-14 01:01:17 +03:00
Jimmy Gitonga
59d92d9eb4
Update docs/developing-locally-docker.rst
Co-authored-by: Bruno Alla <browniebroke@users.noreply.github.com>
2020-08-14 01:00:17 +03:00
Matthias Sieber
279175a344 updated docs 2020-07-27 14:14:15 -07:00
Bruno Alla
08a15337b3
Update document.rst 2020-07-25 14:39:04 +01:00
Bruno Alla
b592003f87
Fix snippet in documentation 2020-07-25 14:37:54 +01:00
Jimmy Gitonga
bd0ed76421 ADD instructions not include the security certificates in the repo. 2020-07-07 08:07:51 +03:00
Jimmy Gitonga
aacdd97c4e ADD instructions on how to set up a secure development environment. 2020-07-07 01:59:25 +03:00
Jimmy Gitonga
2ec3bdf55c
FIX the link to Let's Encrypt *Automatic HTTPS (#2661)
The link was broken as it was pointing to a non-existent page.
2020-07-06 07:54:32 -07:00
Jimmy Gitonga
697f5e1b6d FIX the link to Let's Encrypt *Automatic HTTPS
The link was broken as it was pointing to a non-existent page.
2020-07-06 17:31:56 +03:00
Bruno Alla
196167490d Merge branch 'master' into docs
# Conflicts:
#	{{cookiecutter.project_slug}}/requirements/local.txt
2020-06-29 21:48:17 +01:00
Bruno Alla
931e5c4267
Merge pull request #2608 from stefanitsky/websocket-docs 2020-06-22 19:55:09 +01:00
Alexandr
7ba61274ce 📝 docs updated after review 2020-06-22 21:42:39 +03:00
Bruno Alla
e095ee9f93
Merge pull request #2600 from tanoabeleyra/s3-cdn
Allow to use a CDN with S3
2020-06-21 15:07:35 +01:00
Andrew Chen Wang
8bdef165a8
Fixed local async command in docs 2020-06-16 23:51:21 -04:00
Tano Abeleyra
009ca15a4c Add AWS_S3_CUSTOM_DOMAIN entry to settings.rst 2020-05-28 19:16:54 -03:00
Alexandr
286363799c 📝 added websockets doc page #2506
* Simple explanation.
* Example of usage with JS.
* Additional nGinx config example.
2020-05-26 01:25:38 +03:00
Hannah Lazarus
3152bdaeb3 Add sphinx defaults for cookiecutter'd project
-serve, watch + live reload for docs + code file changes
-update project makefile + make.bat
-separate _source and _build
-add packages and paths to use autodoc
-edit/add documentation with examples (both at django-cookiecutter and inside generated project)
-add formatted comments in User model for pickup by Sphinx apidoc
-serve docs from a separate docs container for docker build
2020-04-30 13:23:24 -04:00
Bruno Alla
d86bd3280a
Merge pull request #2545 from hanhanhan/name_containers 2020-04-28 12:47:45 +01: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
Hannah Lazarus
f9c20af456 Add container_names for docker commands
container_names make it possible to run docker commands
without looking up container hash
use in dev.yml
2020-04-24 16:31:20 -04: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
Bruno Alla
2993bbf78f
Merge pull request #2514 from codnee/python_3.8
Upgrade to Python 3.8
2020-04-13 15:13:32 +01:00
Andrew Chen Wang
2ecbf7ac34
Merge branch 'master' into async 2020-04-06 23:02:36 -04:00
gwiskur
68d751f2d4 Add compress command when using Django Compressor
If the django-compressor option is selected, then the ``compress`` command is required where COMPRESS_OFFLINE = True is default in the production settings.  See here: https://django-compressor.readthedocs.io/en/latest/usage/#offline-compression
2020-04-04 08:59:00 -05:00
Ernesto Cedeno
0cdf60ceac Change Python version to 3.8 2020-03-29 19:55:27 +02:00
Fabio C. Barrioneuvo da Luz
83f28a592c Migrate book domain to Feldroy and other small fixes 2020-03-25 11:57:33 -03:00
Andrew-Chen-Wang
aee2de347b Add uvicorn and web sockets for Django 3
* Add use_async option to cookiecutter.json
* Add websocket configuration
2020-03-24 15:40:14 -04:00
Andrew-Chen-Wang
484fa4ae77 Added unsupported mail_service combinations
* Added default yaml Loader for pre_gen_projects.py
2020-03-22 13:31:52 -04:00
Andrew-Chen-Wang
9cf72849e6 Merged parent repo and configured refurbished tests 2020-03-14 13:29:08 -04:00
Bruno Alla
48f7a4a7d2
Merge pull request #2433 from demestav/master
Flower now served by Traefik
2020-02-23 11:32:47 +00:00
Andrew-Chen-Wang
ac884f3f75 Updated mail service docs
* Trying to appease the Black-linter god...
2020-02-06 20:18:49 -05:00
Leonardo
45c353241b
Include use_drf option on documentation 2020-02-06 05:37:31 -04:00
Demetris Stavrou
25a70c5b84 Added Flower access documentation for production. 2020-02-04 22:47:56 +02:00
Bruno Alla
4bf0533bfa Fix broken links duplicated from testing.rst 2020-01-23 18:39:38 +00:00
Bruno Alla
00772d7141 Merge remote-tracking branch 'origin/master' into update-doc 2020-01-23 18:38:26 +00:00
Bruno Alla
bc00a343ea Fix broken links in doc fixes #2408 2020-01-22 10:52:31 +00:00
howiezhao
16b219034a Update docs files 2019-12-28 17:26:43 +08:00
Ivan Khomutov
113ce88d9c Add option to choose CI tool 2019-12-06 10:55:00 +03:00
Bruno Alla
d68db825e2
Add pre-commit for the generated project. (#2171) (#2295)
Add pre-commit for the generated project. (#2171)
2019-11-04 13:38:02 +01:00
Gilbishkosma
91c6f69a57
Update deployment-with-docker.rst 2019-11-03 19:51:56 +05:30
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
Min ho Kim
62df724c8c Fix typo 2019-06-15 06:37:58 +10:00
Bruno Alla
d04b128e0f Typo in doc reference 2019-05-29 14:55:38 +01:00
Bruno Alla
3de1715b12 Add troubleshooting section regarding Posgres auth issues - fixes #1678 2019-05-29 14:54:18 +01:00
Bruno Alla
7e47e9c2aa
Mailgun api url (#2014)
Mailgun api url
2019-05-28 11:27:54 +01:00
Tano Abeleyra
9a3a796a89 Use GCP acronym for Google Cloud Platform 2019-05-27 17:39:45 -03:00
Bruno Alla
007f3ffb31 Docs update 2019-05-27 18:16:51 +01:00
Bruno Alla
2d1befe8e2 Update docs about settings 2019-05-27 18:16:00 +01:00
Bruno Alla
c245c1ab09 Update copyright year in the docs 2019-05-27 17:19:24 +01:00
Bruno Alla
92e4bdf171
Make cloud_provider optional (#2067)
Make cloud_provider optional
2019-05-27 15:50:18 +01:00
Demetris Stavrou
61c842cd9d
Update docs/deployment-with-docker.rst
Co-Authored-By: Bruno Alla <browniebroke@users.noreply.github.com>
2019-05-22 09:47:03 +03:00
Demetris Stavrou
7cc94c139c Updated documentation 2019-05-21 22:44:10 +03:00
Curtis St Pierre
4bf795a908 1989 - reworked postgres version options 2019-05-20 08:53:07 -07:00
Tano Abeleyra
de7be3652a Make cloud_provider optional
Some projects may not need AWS or GCS
2019-05-19 12:45:28 -03:00
Bruno Alla
3b96afc559 Deduplicate troubleshooting sections about Mailgun 2019-05-12 21:57:16 +01:00
Bruno Alla
39df72669e Merge branch 'master' into upgrade/django-2.1
# Conflicts:
#	README.rst
2019-04-17 08:33:54 +01:00
Bruno Alla
cd13ab4c82 Update docs/settings.rst
Documented GOOGLE_APPLICATION_CREDENTIALS env var

Co-Authored-By: vladdoster <Dosterm@wit.edu>
2019-04-16 11:30:22 -05:00
Bruno Alla
f6cac35b87 Update docs/project-generation-options.rst
Clearer diction describing cloud provider roles

Co-Authored-By: vladdoster <Dosterm@wit.edu>
2019-04-16 11:23:41 -05:00
Vlad
c041453bef Updated project-generation-options.rst to provide helpful links in case a user needs to decide between AWS s3 and GCS and added myself to contributors.rst 2019-04-14 12:07:37 -05:00
Vlad
7c8a473460 Updated settings.rst to reflect new GS env variable 2019-04-14 11:57:48 -05:00
Vlad
56aa332e01 Documented Google Cloud Storage integration as an alternative to AWS S3 2019-04-14 11:43:05 -05:00
Bruno Alla
2dcbaca3ee Update documentation 2019-04-02 19:38:23 +01:00