From d0e27716c934658bab5b36a963f3b5243c004c33 Mon Sep 17 00:00:00 2001 From: Lyla Fischer Date: Sat, 28 Sep 2013 22:07:40 -0400 Subject: [PATCH 1/4] added a pointer to app-specific documentation --- README.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 10c5f779..1c1ccac0 100644 --- a/README.rst +++ b/README.rst @@ -83,8 +83,11 @@ Create a GitHub repo and push it there:: Now take a look at your repo. Awesome, right? -It's time to write the code!!! +If you check out your new application, you will see that you can find documentation in the "docs" directory that explains everything about your app as it exists in its initial cookiecutter state, including how to deploy it. +If you want to read the documentation from your browser instead of a text editing window, you'll have to compile it first. First, make sure that you have all of the local packages that you need (including the ones you need to generate this documentation) by running "pip install -r requirements/local.txt". Go into the docs directory and run "make html". That will generate html from the .rst files. If you point your browser to your local variant of "/path/to/my_cookiecutter_project/docs/_build/html/index.html". + +So, you now have a simple django application. Go forth and code! "Your Stuff" ------------- From da942d59d4020a303da200d35523b1fc595731f8 Mon Sep 17 00:00:00 2001 From: Lyla Fischer Date: Sat, 28 Sep 2013 22:47:24 -0400 Subject: [PATCH 2/4] added how to get database name to deployment docs --- {{cookiecutter.repo_name}}/docs/deploy.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/{{cookiecutter.repo_name}}/docs/deploy.rst b/{{cookiecutter.repo_name}}/docs/deploy.rst index f7e2a9ad..5421fe52 100644 --- a/{{cookiecutter.repo_name}}/docs/deploy.rst +++ b/{{cookiecutter.repo_name}}/docs/deploy.rst @@ -46,6 +46,21 @@ Add memcachier for memcached service:: MemCachier is now up and ready to go. Happy bananas! Use `heroku addons:docs memcachier` to view documentation. +Look up the name of your database. You should have gotten the name as part of the feedback when you created the +database, but just in case you lost that record:: + + $ heroku pg + === HEROKU_POSTGRESQL_GOLD_URL (DATABASE_URL) + Plan: Dev + Status: available + Connections: 1 + PG Version: 9.2.4 + Created: 2013-09-29 02:00 UTC + Data Size: 6.3 MB + Tables: 0 + Rows: 0/10000 (In compliance) + Fork/Follow: Unsupported + Promote the database you just created. Please note that your database might be called something other than "GOLD":: $ heroku pg:promote HEROKU_POSTGRESQL_GOLD From ee3936997bf32504f303f009c93e4c00fe77e768 Mon Sep 17 00:00:00 2001 From: Lyla Fischer Date: Sat, 28 Sep 2013 22:55:03 -0400 Subject: [PATCH 3/4] added instructions on how to run python from heroku --- {{cookiecutter.repo_name}}/docs/deploy.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/{{cookiecutter.repo_name}}/docs/deploy.rst b/{{cookiecutter.repo_name}}/docs/deploy.rst index 5421fe52..eda5220c 100644 --- a/{{cookiecutter.repo_name}}/docs/deploy.rst +++ b/{{cookiecutter.repo_name}}/docs/deploy.rst @@ -124,7 +124,11 @@ TODO: Explain how to serve static files with dj-static_. .. _dj-static: https://github.com/kennethreitz/dj-static -Run this script: (TODO - automate this) +Open up a django shell on your heroku instance:: + + $ heroku run python {{cookiecutter.repo_name}}/manage.py shell --settings=config.settings + +Run the following lines of code from within that shell: (TODO - automate this) .. code-block:: python From 3b9e953e66da567ab43d2b2b0509d52d78ce59ee Mon Sep 17 00:00:00 2001 From: Lyla Fischer Date: Sat, 28 Sep 2013 23:36:40 -0400 Subject: [PATCH 4/4] typo fix --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 1c1ccac0..56aff527 100644 --- a/README.rst +++ b/README.rst @@ -85,7 +85,7 @@ Now take a look at your repo. Awesome, right? If you check out your new application, you will see that you can find documentation in the "docs" directory that explains everything about your app as it exists in its initial cookiecutter state, including how to deploy it. -If you want to read the documentation from your browser instead of a text editing window, you'll have to compile it first. First, make sure that you have all of the local packages that you need (including the ones you need to generate this documentation) by running "pip install -r requirements/local.txt". Go into the docs directory and run "make html". That will generate html from the .rst files. If you point your browser to your local variant of "/path/to/my_cookiecutter_project/docs/_build/html/index.html". +If you want to read the documentation from your browser instead of a text editing window, you'll have to compile it first. First, make sure that you have all of the local packages that you need (including the ones you need to generate this documentation) by running "pip install -r requirements/local.txt". Go into the docs directory and run "make html". That will generate html from the .rst files. Point your browser to your local variant of "/path/to/my_cookiecutter_project/docs/_build/html/index.html". So, you now have a simple django application. Go forth and code!