make the docs less verbose so they're more readable in plaintext

This commit is contained in:
Nate Aune 2013-09-27 10:48:47 -04:00
parent 21af4cf2b8
commit e902821117

View File

@ -42,55 +42,41 @@ Add pgbackups to handle backups of the PostgreSQL database::
Add sendgrid to handle the sending of emails:: Add sendgrid to handle the sending of emails::
.. code-block:: bash
$ heroku addons:add sendgrid:starter $ heroku addons:add sendgrid:starter
Adding sendgrid:starter on {{cookiecutter.project_name}}... done, v5 (free) Adding sendgrid:starter on {{cookiecutter.project_name}}... done, v5 (free)
Use `heroku addons:docs sendgrid` to view documentation. Use `heroku addons:docs sendgrid` to view documentation.
Add memcachier for memcached service:: Add memcachier for memcached service::
.. code-block:: bash
$ heroku addons:add memcachier:dev $ heroku addons:add memcachier:dev
Adding memcachier:dev on {{cookiecutter.project_name}}... done, v7 (free) Adding memcachier:dev on {{cookiecutter.project_name}}... done, v7 (free)
MemCachier is now up and ready to go. Happy bananas! MemCachier is now up and ready to go. Happy bananas!
Use `heroku addons:docs memcachier` to view documentation. Use `heroku addons:docs memcachier` to view documentation.
Promote the database you just created. Please note that your database might be called something other than "GOLD". Promote the database you just created. Please note that your database might be called something other than "GOLD"::
.. code-block:: bash
$ heroku pg:promote HEROKU_POSTGRESQL_GOLD $ heroku pg:promote HEROKU_POSTGRESQL_GOLD
Promoting HEROKU_POSTGRESQL_GOLD_URL to DATABASE_URL... done Promoting HEROKU_POSTGRESQL_GOLD_URL to DATABASE_URL... done
Set the DJANGO_CONFIGURATION environment variable so that Heroku knows we're in production. Set the DJANGO_CONFIGURATION environment variable so that Heroku knows we're in production::
.. code-block:: bash
$ heroku config:add DJANGO_CONFIGURATION=Production $ heroku config:add DJANGO_CONFIGURATION=Production
Setting config vars and restarting {{cookiecutter.project_name}}... done, v8 Setting config vars and restarting {{cookiecutter.project_name}}... done, v8
DJANGO_CONFIGURATION: Production DJANGO_CONFIGURATION: Production
Don't forget to replace the secret key with a random string. Don't forget to replace the secret key with a random string::
.. code-block:: bash
$ heroku config:add DJANGO_SECRET_KEY='!!!REPLACE-ME!!!' $ heroku config:add DJANGO_SECRET_KEY='!!!REPLACE-ME!!!'
Setting config vars and restarting {{cookiecutter.project_name}}... done, v9 Setting config vars and restarting {{cookiecutter.project_name}}... done, v9
DJANGO_SECRET_KEY: abcdefghijklmnopqrstuvwxyz DJANGO_SECRET_KEY: abcdefghijklmnopqrstuvwxyz
If you're using AWS S3 to serve up static assets, then you need to set these values. If you're using AWS S3 to serve up static assets, then you need to set these values::
.. code-block:: bash
$ heroku config:add DJANGO_AWS_ACCESS_KEY_ID=YOUR_ID $ heroku config:add DJANGO_AWS_ACCESS_KEY_ID=YOUR_ID
$ heroku config:add DJANGO_AWS_SECRET_ACCESS_KEY=YOUR_KEY $ heroku config:add DJANGO_AWS_SECRET_ACCESS_KEY=YOUR_KEY
$ heroku config:add DJANGO_AWS_STORAGE_BUCKET_NAME=BUCKET $ heroku config:add DJANGO_AWS_STORAGE_BUCKET_NAME=BUCKET
Commit all the files in your project, and now we're finally ready to push the code to Heroku! Commit all the files in your project, and now we're finally ready to push the code to Heroku!::
.. code-block:: bash
$ git commit -a $ git commit -a
$ git push heroku master $ git push heroku master
@ -120,6 +106,8 @@ Commit all the files in your project, and now we're finally ready to push the co
To git@heroku.com:{{cookiecutter.project_name}}.git To git@heroku.com:{{cookiecutter.project_name}}.git
* [new branch] master -> master * [new branch] master -> master
Run the syncdb, migrate and collectstatic Django management commands::
$ heroku run python {{cookiecutter.repo_name}}/manage.py syncdb --noinput --settings=config.settings $ heroku run python {{cookiecutter.repo_name}}/manage.py syncdb --noinput --settings=config.settings
$ heroku run python {{cookiecutter.repo_name}}/manage.py migrate --settings=config.settings $ heroku run python {{cookiecutter.repo_name}}/manage.py migrate --settings=config.settings
$ heroku run python {{cookiecutter.repo_name}}/manage.py collectstatic --settings=config.settings $ heroku run python {{cookiecutter.repo_name}}/manage.py collectstatic --settings=config.settings