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/docs/index.rst b/docs/index.rst index 3b0a268ca..cd8575b6c 100644 --- a/docs/index.rst +++ b/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 ================== diff --git a/docs/local_development.rst b/docs/local_development.rst new file mode 100644 index 000000000..1d386b1e2 --- /dev/null +++ b/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* diff --git a/docs/production.rst b/docs/production.rst new file mode 100644 index 000000000..c0d54161f --- /dev/null +++ b/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* 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/docs/setup.rst b/docs/setup.rst new file mode 100644 index 000000000..f779984c2 --- /dev/null +++ b/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* diff --git a/docs/the_project.rst b/docs/the_project.rst new file mode 100644 index 000000000..c8ea1254e --- /dev/null +++ b/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* diff --git a/{{cookiecutter.project_slug}}/docs/deploy.rst b/{{cookiecutter.project_slug}}/docs/deploy.rst index 1e642c798..b29d5ac56 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: https://cookiecutter-django.readthedocs.io/en/latest/ 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..ec3f39bd8 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: https://cookiecutter-django.readthedocs.io/en/latest/