From ca5121952443428fad4d48b134e7aca3a5e4717f Mon Sep 17 00:00:00 2001 From: Jannis Gebauer Date: Sat, 25 Feb 2017 13:12:54 +0100 Subject: [PATCH 1/4] clean up project docs --- .../docs => docs}/docker_ec2.rst | 0 .../docs => docs}/pycharm/configuration.rst | 0 .../docs => docs}/pycharm/images/1.png | Bin .../docs => docs}/pycharm/images/2.png | Bin .../docs => docs}/pycharm/images/3.png | Bin .../docs => docs}/pycharm/images/4.png | Bin .../docs => docs}/pycharm/images/5.png | Bin .../docs => docs}/pycharm/images/6.png | Bin .../docs => docs}/pycharm/images/7.png | Bin .../docs => docs}/pycharm/images/8.png | Bin .../docs => docs}/pycharm/images/f1.png | Bin .../docs => docs}/pycharm/images/f2.png | Bin .../docs => docs}/pycharm/images/f3.png | Bin .../docs => docs}/pycharm/images/f4.png | Bin .../docs => docs}/pycharm/images/issue1.png | Bin .../docs => docs}/pycharm/images/issue2.png | Bin {{cookiecutter.project_slug}}/docs/deploy.rst | 10 ++++++++-- {{cookiecutter.project_slug}}/docs/index.rst | 4 +--- {{cookiecutter.project_slug}}/docs/install.rst | 10 ++++++++-- 19 files changed, 17 insertions(+), 7 deletions(-) rename {{{cookiecutter.project_slug}}/docs => docs}/docker_ec2.rst (100%) rename {{{cookiecutter.project_slug}}/docs => docs}/pycharm/configuration.rst (100%) rename {{{cookiecutter.project_slug}}/docs => docs}/pycharm/images/1.png (100%) rename {{{cookiecutter.project_slug}}/docs => docs}/pycharm/images/2.png (100%) rename {{{cookiecutter.project_slug}}/docs => docs}/pycharm/images/3.png (100%) rename {{{cookiecutter.project_slug}}/docs => docs}/pycharm/images/4.png (100%) rename {{{cookiecutter.project_slug}}/docs => docs}/pycharm/images/5.png (100%) rename {{{cookiecutter.project_slug}}/docs => docs}/pycharm/images/6.png (100%) rename {{{cookiecutter.project_slug}}/docs => docs}/pycharm/images/7.png (100%) rename {{{cookiecutter.project_slug}}/docs => docs}/pycharm/images/8.png (100%) rename {{{cookiecutter.project_slug}}/docs => docs}/pycharm/images/f1.png (100%) rename {{{cookiecutter.project_slug}}/docs => docs}/pycharm/images/f2.png (100%) rename {{{cookiecutter.project_slug}}/docs => docs}/pycharm/images/f3.png (100%) rename {{{cookiecutter.project_slug}}/docs => docs}/pycharm/images/f4.png (100%) rename {{{cookiecutter.project_slug}}/docs => docs}/pycharm/images/issue1.png (100%) rename {{{cookiecutter.project_slug}}/docs => docs}/pycharm/images/issue2.png (100%) diff --git a/{{cookiecutter.project_slug}}/docs/docker_ec2.rst b/docs/docker_ec2.rst similarity index 100% rename from {{cookiecutter.project_slug}}/docs/docker_ec2.rst rename to docs/docker_ec2.rst diff --git a/{{cookiecutter.project_slug}}/docs/pycharm/configuration.rst b/docs/pycharm/configuration.rst similarity index 100% rename from {{cookiecutter.project_slug}}/docs/pycharm/configuration.rst rename to docs/pycharm/configuration.rst diff --git a/{{cookiecutter.project_slug}}/docs/pycharm/images/1.png b/docs/pycharm/images/1.png similarity index 100% rename from {{cookiecutter.project_slug}}/docs/pycharm/images/1.png rename to docs/pycharm/images/1.png diff --git a/{{cookiecutter.project_slug}}/docs/pycharm/images/2.png b/docs/pycharm/images/2.png similarity index 100% rename from {{cookiecutter.project_slug}}/docs/pycharm/images/2.png rename to docs/pycharm/images/2.png diff --git a/{{cookiecutter.project_slug}}/docs/pycharm/images/3.png b/docs/pycharm/images/3.png similarity index 100% rename from {{cookiecutter.project_slug}}/docs/pycharm/images/3.png rename to docs/pycharm/images/3.png diff --git a/{{cookiecutter.project_slug}}/docs/pycharm/images/4.png b/docs/pycharm/images/4.png similarity index 100% rename from {{cookiecutter.project_slug}}/docs/pycharm/images/4.png rename to docs/pycharm/images/4.png diff --git a/{{cookiecutter.project_slug}}/docs/pycharm/images/5.png b/docs/pycharm/images/5.png similarity index 100% rename from {{cookiecutter.project_slug}}/docs/pycharm/images/5.png rename to docs/pycharm/images/5.png diff --git a/{{cookiecutter.project_slug}}/docs/pycharm/images/6.png b/docs/pycharm/images/6.png similarity index 100% rename from {{cookiecutter.project_slug}}/docs/pycharm/images/6.png rename to docs/pycharm/images/6.png diff --git a/{{cookiecutter.project_slug}}/docs/pycharm/images/7.png b/docs/pycharm/images/7.png similarity index 100% rename from {{cookiecutter.project_slug}}/docs/pycharm/images/7.png rename to docs/pycharm/images/7.png diff --git a/{{cookiecutter.project_slug}}/docs/pycharm/images/8.png b/docs/pycharm/images/8.png similarity index 100% rename from {{cookiecutter.project_slug}}/docs/pycharm/images/8.png rename to docs/pycharm/images/8.png diff --git a/{{cookiecutter.project_slug}}/docs/pycharm/images/f1.png b/docs/pycharm/images/f1.png similarity index 100% rename from {{cookiecutter.project_slug}}/docs/pycharm/images/f1.png rename to docs/pycharm/images/f1.png diff --git a/{{cookiecutter.project_slug}}/docs/pycharm/images/f2.png b/docs/pycharm/images/f2.png similarity index 100% rename from {{cookiecutter.project_slug}}/docs/pycharm/images/f2.png rename to docs/pycharm/images/f2.png diff --git a/{{cookiecutter.project_slug}}/docs/pycharm/images/f3.png b/docs/pycharm/images/f3.png similarity index 100% rename from {{cookiecutter.project_slug}}/docs/pycharm/images/f3.png rename to docs/pycharm/images/f3.png diff --git a/{{cookiecutter.project_slug}}/docs/pycharm/images/f4.png b/docs/pycharm/images/f4.png similarity index 100% rename from {{cookiecutter.project_slug}}/docs/pycharm/images/f4.png rename to docs/pycharm/images/f4.png diff --git a/{{cookiecutter.project_slug}}/docs/pycharm/images/issue1.png b/docs/pycharm/images/issue1.png similarity index 100% rename from {{cookiecutter.project_slug}}/docs/pycharm/images/issue1.png rename to docs/pycharm/images/issue1.png diff --git a/{{cookiecutter.project_slug}}/docs/pycharm/images/issue2.png b/docs/pycharm/images/issue2.png similarity index 100% rename from {{cookiecutter.project_slug}}/docs/pycharm/images/issue2.png rename to docs/pycharm/images/issue2.png diff --git a/{{cookiecutter.project_slug}}/docs/deploy.rst b/{{cookiecutter.project_slug}}/docs/deploy.rst index 1e642c798..e5c82a147 100644 --- a/{{cookiecutter.project_slug}}/docs/deploy.rst +++ b/{{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: http://aws.amazon.com/ diff --git a/{{cookiecutter.project_slug}}/docs/index.rst b/{{cookiecutter.project_slug}}/docs/index.rst index 21ef98ee5..501f5e263 100644 --- a/{{cookiecutter.project_slug}}/docs/index.rst +++ b/{{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 diff --git a/{{cookiecutter.project_slug}}/docs/install.rst b/{{cookiecutter.project_slug}}/docs/install.rst index 1bc03335d..652b54b3f 100644 --- a/{{cookiecutter.project_slug}}/docs/install.rst +++ b/{{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: http://aws.amazon.com/ From 87014f1a55743584917b0fc4fdf70ec755265e2e Mon Sep 17 00:00:00 2001 From: Jannis Gebauer Date: Sat, 25 Feb 2017 13:14:13 +0100 Subject: [PATCH 2/4] use the correct URL --- {{cookiecutter.project_slug}}/docs/deploy.rst | 2 +- {{cookiecutter.project_slug}}/docs/install.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/{{cookiecutter.project_slug}}/docs/deploy.rst b/{{cookiecutter.project_slug}}/docs/deploy.rst index e5c82a147..b29d5ac56 100644 --- a/{{cookiecutter.project_slug}}/docs/deploy.rst +++ b/{{cookiecutter.project_slug}}/docs/deploy.rst @@ -7,4 +7,4 @@ This project was generated with Cookiecutter Django, take a look at the `officia info. -.. _official docs: http://aws.amazon.com/ +.. _official docs: https://cookiecutter-django.readthedocs.io/en/latest/ diff --git a/{{cookiecutter.project_slug}}/docs/install.rst b/{{cookiecutter.project_slug}}/docs/install.rst index 652b54b3f..ec3f39bd8 100644 --- a/{{cookiecutter.project_slug}}/docs/install.rst +++ b/{{cookiecutter.project_slug}}/docs/install.rst @@ -7,4 +7,4 @@ This project was generated with Cookiecutter Django, take a look at the `officia info. -.. _official docs: http://aws.amazon.com/ +.. _official docs: https://cookiecutter-django.readthedocs.io/en/latest/ From 32f2491c44b514c53afca379e83912c1fb85538d Mon Sep 17 00:00:00 2001 From: Jannis Gebauer Date: Sat, 25 Feb 2017 13:27:45 +0100 Subject: [PATCH 3/4] use the new docs layout --- docs/index.rst | 20 +++++--------------- docs/local_development.rst | 14 ++++++++++++++ docs/production.rst | 14 ++++++++++++++ docs/setup.rst | 14 ++++++++++++++ docs/the_project.rst | 14 ++++++++++++++ 5 files changed, 61 insertions(+), 15 deletions(-) create mode 100644 docs/local_development.rst create mode 100644 docs/production.rst create mode 100644 docs/setup.rst create mode 100644 docs/the_project.rst diff --git a/docs/index.rst b/docs/index.rst index bfa88f18c..1e478a656 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,7 +1,7 @@ .. cookiecutter-django documentation master file. Welcome to Cookiecutter Django's documentation! -==================================================================== +=============================================== A Cookiecutter_ template for Django. @@ -12,20 +12,10 @@ 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 ================== diff --git a/docs/local_development.rst b/docs/local_development.rst new file mode 100644 index 000000000..ada99c366 --- /dev/null +++ b/docs/local_development.rst @@ -0,0 +1,14 @@ +Local Development +================= + +*Todo* + +FAQ +--- + +*Todo* + +Troubleshooting +--------------- + +*Todo* diff --git a/docs/production.rst b/docs/production.rst new file mode 100644 index 000000000..f77882452 --- /dev/null +++ b/docs/production.rst @@ -0,0 +1,14 @@ +Production +========== + +*Todo* + +FAQ +--- + +*Todo* + +Troubleshooting +--------------- + +*Todo* diff --git a/docs/setup.rst b/docs/setup.rst new file mode 100644 index 000000000..1eeb5cc0a --- /dev/null +++ b/docs/setup.rst @@ -0,0 +1,14 @@ +Setup +===== + +*Todo* + +FAQ +--- + +*Todo* + +Troubleshooting +--------------- + +*Todo* diff --git a/docs/the_project.rst b/docs/the_project.rst new file mode 100644 index 000000000..be496ad4f --- /dev/null +++ b/docs/the_project.rst @@ -0,0 +1,14 @@ +The Project +=========== + +*Todo* + +FAQ +--- + +*Todo* + +Troubleshooting +--------------- + +*Todo* From adce52418b88b1dacb9460438e98a5da4fb9e032 Mon Sep 17 00:00:00 2001 From: Jannis Gebauer Date: Sat, 25 Feb 2017 14:08:50 +0100 Subject: [PATCH 4/4] 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 1e478a656..5bb1df148 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 ada99c366..1d386b1e2 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 f77882452..c0d54161f 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 1eeb5cc0a..f779984c2 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 be496ad4f..c8ea1254e 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