Merge pull request #28 from aio-libs/updates_in_template_static_bg_docs

Updates in template static bg docs

Author: gyermolenko

Diff for: README.rst

@@ -48,27 +48,35 @@ Simple polls application with postgresql storage.
     :width: 460px
 
 
-Improvement plan
-----------------
-(in no particular order)
+Contributing
+------------
+Things you need for local development::
+
+    $ pip install -r requirements-dev.txt
 
-- Update `polls` app and related `tutorial.rst` sections
+After that - follow setup instructions from particular demo project.
 
-  - [x] create configuration steps (venv, pip install, db initialization)
-  - [x] fix or recreate tests
-  - [ ] revise `tutorial.rst`
+To check documentation locally click the ``open file`` link from the output
+of this command::
 
-- `tutorial.rst`
+    $ make doc
 
-  - add "What's next" section
+To make sure everything is ok before committing::
 
-- add Issues
+    $ make ci
 
-- engage community
 
-  - [ ] setup communication channels (gitter?)
-  - [ ] discuss roadmap
-  - [ ] issues
-  - [ ] examples
+Improvement plan
+----------------
 
-- in case of success - fix urls from `aiohttp/tutorial`
+Polls:
+
+- [+] create configuration steps (venv, pip install, db initialization)
+- [+] fix or recreate tests
+- [~] revise `tutorial.rst`
+- [+] fix urls from `aiohttp/tutorial`
+- [x] setup communication channels (aio-libs gitter channel is enough)
+- [~] create missing issues
+- [+] add "Contributing" section
+- [ ] add "What's next" section
+- [ ] discuss roadmap

Diff for: demos/README.rst

@@ -8,13 +8,16 @@ similar to Django one.
 Preparations
 ------------
 
+Details could be found in :ref:`aiohttp-demos-polls-preparations-database`.
+In short.
+
 Run Postgres DB server::
 
     $ docker run --rm -it -p 5432:5432 postgres:10
 
 Create db and populate it with sample data::
 
-    $ python tests/init_db.py
+    $ python init_db.py
 
 
 Run
@@ -34,16 +37,30 @@ Open browser::
 Tests
 -----
 
-Run integration tests::
+.. code-block:: shell
+
+    $ pytest tests
 
-    $ pytest tests/test_integration.py
+or:
 
-or::
+.. code-block:: shell
 
     $ pip install tox
     $ tox
 
 
+Development
+-----------
+Please review general contribution info at `README <https://github.com/aio-libs/aiohttp-demos#contributing>_`.
+
+
+Also for illustration purposes it is useful to show project structure when it changes,
+like in :ref:`aiohttp-demos-polls-preparations-project-structure`. Here is how you
+can do that::
+
+    $ tree -I "__pycache__|aiohttpdemo_polls.egg-info" --dirsfirst
+
+
 Requirements
 ============
 * aiohttp_

Diff for: demos/polls/README.rst

@@ -3,5 +3,5 @@ li a {
 }
 
 body {
-    background: white url("images/background.gif") no-repeat right bottom;
+    background: white url("images/background.png") no-repeat;
 }

Diff for: demos/polls/aiohttpdemo_polls/static/images/background.png

@@ -5,7 +5,7 @@
 {% block content %}
 <ul>
 {% for choice in choices %}
-    <li>{{ choice.choice_text }} -- {{ choice.votes }} vote{{ choice.votes }}</li>
+    <li>{{ choice.choice_text }} -- {{ choice.votes }} vote(s)</li>
 {% endfor %}
 </ul>
 

Diff for: demos/polls/aiohttpdemo_polls/static/style.css

@@ -2,7 +2,7 @@
 
 from aiohttpdemo_polls.main import init_app
 from aiohttpdemo_polls.settings import BASE_DIR, get_config
-from .init_db import (
+from init_db import (
     setup_db,
     teardown_db,
     create_tables,

Diff for: demos/polls/aiohttpdemo_polls/templates/results.html

@@ -23,10 +23,10 @@ web projects:
 .. code-block:: none
 
     .
-    ├── Makefile
-    ├── README.rst
     ├── aiohttpdemo_polls
     │   ├── static
+    │   │   ├── images
+    │   │   │   └── background.png
     │   │   └── style.css
     │   ├── templates
     │   │   ├── 404.html
@@ -35,24 +35,28 @@ web projects:
     │   │   ├── detail.html
     │   │   ├── index.html
     │   │   └── results.html
+    │   ├── db.py
     │   ├── __init__.py
     │   ├── __main__.py
-    │   ├── db.py
     │   ├── main.py
     │   ├── middlewares.py
     │   ├── routes.py
+    │   ├── settings.py
     │   ├── utils.py
     │   └── views.py
     ├── config
-    │   ├── polls.yaml
-    │   └── polls_test.yaml
+    │   ├── polls_test.yaml
+    │   └── polls.yaml
+    ├── tests
+    │   ├── conftest.py
+    │   ├── __init__.py
+    │   └── test_integration.py
+    ├── init_db.py
+    ├── Makefile
+    ├── README.rst
     ├── requirements.txt
     ├── setup.py
-    └── tests
-        ├── __init__.py
-        ├── conftest.py
-        ├── init_db.py
-        └── test_integration.py
+    └── tox.ini
 
 
 .. _aiohttp-demos-polls-preparations-environment:
@@ -80,16 +84,16 @@ environment. For example, ``$ pip install aiopg`` before database related sectio
 Check you python version (tutorial requires Python 3.5 or newer)::
 
    $ python -V
-   Python 3.6.3
+   Python 3.6.5
 
 Install ``aiohttp`` ::
 
     $ pip install aiohttp
 
-Check the aiohttp version (tutorial requires v2.0 or newer)::
+Check the aiohttp version::
 
     $ python3 -c 'import aiohttp; print(aiohttp.__version__)'
-    2.3.1
+    3.1.3
 
 
 .. _aiohttp-demos-polls-preparations-database:
@@ -131,7 +135,7 @@ Use ``\l`` and ``\du`` *psql* commands to check results.
 .. note::
 
     If you decided to run the application from the repo - this script
-    ( :download:`init_db.py <../demos/polls/tests/init_db.py>` ) will create db
+    ( :download:`init_db.py <../demos/polls/init_db.py>` ) will create db
     at running server, create tables and populate them with sample data ::
 
-        $ python tests/init_db.py
+        $ python init_db.py

Diff for: demos/polls/tests/init_db.py renamed to demos/polls/init_db.py

@@ -340,7 +340,7 @@ Helper script can do that for you. Create new file::
 Install ``aiopg[sa]`` package to interact with database and run the script::
 
     $ pip install aiopg[sa]
-    $ python aiohttpdemo_polls/init_db.py
+    $ python init_db.py
 
 .. note::