From adce52418b88b1dacb9460438e98a5da4fb9e032 Mon Sep 17 00:00:00 2001 From: Jannis Gebauer Date: Sat, 25 Feb 2017 14:08:50 +0100 Subject: [PATCH] make a first rough layout --- docs/index.rst | 2 ++ docs/local_development.rst | 57 ++++++++++++++++++++++++++++++-- docs/production.rst | 67 ++++++++++++++++++++++++++++++++++++-- docs/setup.rst | 31 ++++++++++++++++++ docs/the_project.rst | 25 ++++++++++++++ 5 files changed, 178 insertions(+), 4 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 1e478a65..5bb1df14 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,6 +7,8 @@ A Cookiecutter_ template for Django. .. _cookiecutter: https://github.com/audreyr/cookiecutter +**Todo:** some infos about each section here + Contents: .. toctree:: diff --git a/docs/local_development.rst b/docs/local_development.rst index ada99c36..1d386b1e 100644 --- a/docs/local_development.rst +++ b/docs/local_development.rst @@ -1,14 +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* diff --git a/docs/production.rst b/docs/production.rst index f7788245..c0d54161 100644 --- a/docs/production.rst +++ b/docs/production.rst @@ -1,14 +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* diff --git a/docs/setup.rst b/docs/setup.rst index 1eeb5cc0..f779984c 100644 --- a/docs/setup.rst +++ b/docs/setup.rst @@ -1,8 +1,39 @@ 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 --- diff --git a/docs/the_project.rst b/docs/the_project.rst index be496ad4..c8ea1254 100644 --- a/docs/the_project.rst +++ b/docs/the_project.rst @@ -1,6 +1,31 @@ The Project =========== +**Todo:** quick intro what this document covers. + +Project Structure +----------------- + +*Todo* + +Features +-------- + +*Todo* + +Settings +-------- + +*Todo* + +Dependencies +------------ + +*Todo* + +Third Party Services +-------------------- + *Todo* FAQ