mirror of
https://github.com/cookiecutter/cookiecutter-django.git
synced 2025-02-26 16:30:39 +03:00
Group docs into sections (#5426)
This commit is contained in:
parent
6c64a810b4
commit
b0c45224f1
|
@ -257,7 +257,7 @@ Here is a link to an article on `how to add HTTPS using Nginx`_ to your local do
|
|||
Webpack
|
||||
~~~~~~~
|
||||
|
||||
If you are using Webpack, first install ``mkcert``_. It is a simple by design tool that hides all the arcane knowledge required to generate valid TLS certificates. It works for any hostname or IP, including localhost. It supports macOS, Linux, and Windows, and Firefox, Chrome and Java. It even works on mobile devices with a couple manual steps. See https://blog.filippo.io/mkcert-valid-https-certificates-for-localhost/
|
||||
If you are using Webpack, first install `mkcert`_. It is a simple by design tool that hides all the arcane knowledge required to generate valid TLS certificates. It works for any hostname or IP, including localhost. It supports macOS, Linux, and Windows, and Firefox, Chrome and Java. It even works on mobile devices with a couple manual steps. See https://blog.filippo.io/mkcert-valid-https-certificates-for-localhost/
|
||||
|
||||
.. _`mkcert`: https://github.com/FiloSottile/mkcert/blob/master/README.md#supported-root-stores
|
||||
|
|
@ -24,8 +24,7 @@ First things first.
|
|||
|
||||
$ source <virtual env path>/bin/activate
|
||||
|
||||
#.
|
||||
.. include:: generate-project-block.rst
|
||||
#. .. include:: generate-project-block.rst
|
||||
|
||||
#. Install development requirements: ::
|
||||
|
||||
|
@ -219,7 +218,7 @@ The project comes with a simple task for manual testing purposes, inside `<proje
|
|||
|
||||
You can also use Django admin to queue up tasks, thanks to the `django-celerybeat`_ package.
|
||||
|
||||
.. _Getting started with Redis guide: https://redis.io/docs/getting-started/
|
||||
.. _Getting started with Redis: https://redis.io/docs/getting-started/
|
||||
.. _Celery Workers Guide: https://docs.celeryq.dev/en/stable/userguide/workers.html
|
||||
.. _django-celerybeat: https://django-celery-beat.readthedocs.io/en/latest/
|
||||
|
3
docs/6-about/contributing.md
Normal file
3
docs/6-about/contributing.md
Normal file
|
@ -0,0 +1,3 @@
|
|||
```{include} ../../CONTRIBUTING.md
|
||||
|
||||
```
|
|
@ -1,3 +0,0 @@
|
|||
```{include} ../CONTRIBUTING.md
|
||||
|
||||
```
|
|
@ -7,28 +7,51 @@ Powered by Cookiecutter_, Cookiecutter Django is a project template for jumpstar
|
|||
|
||||
.. _cookiecutter: https://github.com/cookiecutter/cookiecutter
|
||||
|
||||
Contents
|
||||
--------
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Getting Started
|
||||
|
||||
1-getting-started/project-generation-options
|
||||
1-getting-started/settings
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Local Development
|
||||
|
||||
project-generation-options
|
||||
developing-locally
|
||||
developing-locally-docker
|
||||
settings
|
||||
linters
|
||||
testing
|
||||
document
|
||||
deployment-on-pythonanywhere
|
||||
deployment-on-heroku
|
||||
deployment-with-docker
|
||||
docker-postgres-backups
|
||||
websocket
|
||||
faq
|
||||
troubleshooting
|
||||
contributing
|
||||
maintainer-guide
|
||||
2-local-development/developing-locally
|
||||
2-local-development/developing-locally-docker
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Deployment
|
||||
|
||||
3-deployment/deployment-on-pythonanywhere
|
||||
3-deployment/deployment-on-heroku
|
||||
3-deployment/deployment-with-docker
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Guides
|
||||
|
||||
4-guides/docker-postgres-backups
|
||||
4-guides/linters
|
||||
4-guides/testing
|
||||
4-guides/document
|
||||
4-guides/websocket
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Help
|
||||
|
||||
5-help/faq
|
||||
5-help/troubleshooting
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: About
|
||||
|
||||
6-about/contributing
|
||||
6-about/maintainer-guide
|
||||
|
||||
Indices and tables
|
||||
------------------
|
||||
|
|
Loading…
Reference in New Issue
Block a user