search

cookiecutter / cookiecutter-django

Cookiecutter Django is a framework for jumpstarting production-ready Django projects quickly.
https://cookiecutter-django.readthedocs.io
BSD 3-Clause "New" or "Revised" License
11.83k stars 2.84k forks source link

Revise docs #1043

Open jayfk opened 7 years ago

jayfk commented 7 years ago

I'm a huge fan of the docs over at cookiecutter-pypackage. They are clean, precise and have a great structure.

I'd like to clean up the docs for Cookiecutter Django and structure them in a similar way. That'd make it easier to get from zero knowledge to a working local environment with a production deployment and will hopefully reduce doc related issues.

What I have in mind is a structure with 4 major categories Setup, The Project, Local Development and Production each with their own precise steps, a FAQ and troubleshooting section.

Setup

Steps taken to create a Cookiecutter Django project

The Project

Everything about the project in general

Local Development

Docker

From nothing to a working development environment with Docker

Vanilla Python

From vanilla Python to a working development environment

Production

Prerequisites

Everything we need prior to deploying to prod which are platform agnostic

Docker

From a fresh linux install to a working Docker deployment

Ubuntu

From a fresh Ubuntu install to a app

Heroku

make clear that this may not be fully supported

Python Anywhere

make clear that this may not be fully supported

This will be a lot of work, but I think it's worth it in the long run. I think the best way to approach this would be if I restructure the docs first, filling each step from the "old" docs and see where we go from there.

Once we have this in place, we'd need people testing them out, report errors and possibly fill in gaps and work on the corresponding FAQ and troubleshooting section.

Who is willing to help here? We need everyone, really. From zero knowledge to a full stack expert running hundreds of Cookiecutters in prod.

pydanny commented 7 years ago

Sounds good to me!

Afrowave commented 7 years ago

@jayfk I am in. I was thinking the same thing and I had begun laying out a version that I would introduce as time went on.

Great minds think alike. 😄

jayfk commented 7 years ago

I've started to work on this on the docs-v2 branch: https://github.com/pydanny/cookiecutter-django/tree/docs-v2

burhan commented 7 years ago

I like it, and am willing to help here.

yusufhilmi commented 4 years ago

Good point, I had lots of problems while setting up, especially in production. (I still have some) And I would want to add a Digital Ocean Deployment section if it's okay.