Merge adce52418b into 38f53b5886

docs/index.rst

@@ -1,31 +1,23 @@
 .. cookiecutter-django documentation master file.
 
 Welcome to Cookiecutter Django's documentation!
-====================================================================
+===============================================
 
 A Cookiecutter_ template for Django.
 
 .. _cookiecutter: https://github.com/audreyr/cookiecutter
 
+**Todo:** some infos about each section here
+
 Contents:
 
 .. toctree::
    :maxdepth: 2
 
-   project-generation-options
-   developing-locally
-   developing-locally-docker
-   settings
-   linters
-   live-reloading-and-sass-compilation
-   deployment-on-pythonanywhere
-   deployment-on-heroku
-   deployment-with-docker
-   docker-postgres-backups
-   faq
-   troubleshooting
-   my-favorite-cookie
-   deployment-with-elastic-beanstalk   
+   setup
+   the_project
+   local_development
+   production
 
 Indices and tables
 ==================

docs/local_development.rst

@@ -0,0 +1,67 @@
+Local Development
+=================
+
+**Todo:** quick intro what this document covers.
+
+Python Virtualenv
+-----------------
+
+Step 1: Make a new virtualenv
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+*Todo*
+
+Step 2: Install development dependencies
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+*Todo*
+
+Step 3: Install Postgres
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+*Todo: Section for windows, linux, mac*
+
+Step 4: Start Django
+^^^^^^^^^^^^^^^^^^^^
+
+*Todo*
+
+FAQ
+^^^
+
+*Todo*
+
+Troubleshooting
+^^^^^^^^^^^^^^^
+
+*Todo*
+
+Docker
+------
+
+Step 1: Install Docker
+^^^^^^^^^^^^^^^^^^^^^^
+
+*Todo*
+
+Step 2: Install Docker Compose
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+*Todo*
+
+Step 3: Start the project
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+*Todo*
+
+
+
+FAQ
+^^^
+
+*Todo*
+
+Troubleshooting
+^^^^^^^^^^^^^^^
+
+*Todo*

docs/production.rst

@@ -0,0 +1,77 @@
+Production
+==========
+
+**Todo:** quick intro what this document covers.
+
+Prerequisites
+-------------
+
+Step 1: Register Domain
+^^^^^^^^^^^^^^^^^^^^^^^
+
+*Todo*
+
+Step 2: Create Mailgun Account
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+*Todo*
+
+Step 3: Create AWS Account
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+*Todo*
+
+FAQ
+^^^
+
+*Todo*
+
+Troubleshooting
+^^^^^^^^^^^^^^^
+
+*Todo*
+
+Docker
+------
+
+*Todo*
+
+FAQ
+^^^
+
+*Todo*
+
+Troubleshooting
+^^^^^^^^^^^^^^^
+
+*Todo*
+
+Ubuntu
+------
+
+*Todo*
+
+FAQ
+^^^
+
+*Todo*
+
+Troubleshooting
+^^^^^^^^^^^^^^^
+
+*Todo*
+
+Elastic Beanstalk (unsupported)
+-------------------------------
+
+*Todo*
+
+Heroku (unsupported)
+--------------------
+
+*Todo*
+
+Python Anywhere (unsupported)
+-----------------------------
+
+*Todo*

docs/setup.rst

@@ -0,0 +1,45 @@
+Setup
+=====
+
+**Todo:** quick intro what this document covers.
+
+Step 1: Install Cookiecutter
+----------------------------
+
+*Todo*
+
+Step 2: Run Cookiecutter Django
+-------------------------------
+
+*Todo*
+
+Step 3: Install Cookiecutter
+----------------------------
+
+*Todo*
+
+Step 4: Create a new GitHub repo (optional)
+-------------------------------------------
+
+*Todo*
+
+Step 5: Add the repo to pyup.io (optional)
+------------------------------------------
+
+*Todo*
+
+Step 6: Add the repo to Travis CI (optional)
+--------------------------------------------
+
+*Todo*
+
+
+FAQ
+---
+
+*Todo*
+
+Troubleshooting
+---------------
+
+*Todo*

docs/the_project.rst

@@ -0,0 +1,39 @@
+The Project
+===========
+
+**Todo:** quick intro what this document covers.
+
+Project Structure
+-----------------
+
+*Todo*
+
+Features
+--------
+
+*Todo*
+
+Settings
+--------
+
+*Todo*
+
+Dependencies
+------------
+
+*Todo*
+
+Third Party Services
+--------------------
+
+*Todo*
+
+FAQ
+---
+
+*Todo*
+
+Troubleshooting
+---------------
+
+*Todo*

{{cookiecutter.project_slug}}/docs/deploy.rst

@@ -1,4 +1,10 @@
 Deploy
-========
+======
 
-This is where you describe how the project is deployed in production.
+*describe how to deploy this project*
+
+This project was generated with Cookiecutter Django, take a look at the `official docs`_ for more
+info.
+
+
+.. _official docs: https://cookiecutter-django.readthedocs.io/en/latest/

{{cookiecutter.project_slug}}/docs/index.rst

@@ -4,7 +4,7 @@
    contain the root `toctree` directive.
 
 Welcome to {{ cookiecutter.project_name }}'s documentation!
-====================================================================
+===========================================================
 
 Contents:
 
@@ -13,8 +13,6 @@ Contents:
 
    install
    deploy
-   docker_ec2
-   tests
 
 
 

{{cookiecutter.project_slug}}/docs/install.rst

@@ -1,4 +1,10 @@
 Install
-=========
+=======
 
-This is where you write how to get a new laptop to run this project.
+*describe how to install this project*
+
+This project was generated with Cookiecutter Django, take a look at the `official docs`_ for more
+info.
+
+
+.. _official docs: https://cookiecutter-django.readthedocs.io/en/latest/