From 271876565f47da27d9a52af9e9bec705cad0cf18 Mon Sep 17 00:00:00 2001 From: Tomasz Mieszkowski Date: Fri, 5 Sep 2014 11:32:30 +0200 Subject: Minor improvements in the docs ('api' and 'configuration' sections). --- doc/api.rst | 6 ++++-- doc/configuration.rst | 21 ++++++++++++++------- 2 files changed, 18 insertions(+), 9 deletions(-) diff --git a/doc/api.rst b/doc/api.rst index 50ae7e4..0979c70 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -43,7 +43,7 @@ Current API version: **v0.1** .. note:: In 99% of cases, probably only ``push`` and ``tileconfig`` will be of - interest to you. + interest to you (and maybe ``tiledata`` too). .. http:post:: /api/(api_version)/(api_key)/push @@ -126,7 +126,9 @@ Current API version: **v0.1** .. http:get:: /api/(api_version)/(api_key)/tiledata/(tile_id) - Retrieves data belonging to the tile specified by `tile_id`. May be useful for diagnostics. + Retrieves data belonging to the tile specified by `tile_id`. May be useful + in cases when you need to re-fetch some parts of your data (e.g. when + updating your team's stats) or just for diagnostics. :param api_version: version of API to be used :param api_key: your API key diff --git a/doc/configuration.rst b/doc/configuration.rst index a4d8f0b..c31bcd4 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -9,13 +9,13 @@ below (see section :ref:`installation`). Default configuration --------------------- -Tipboard launched after installation present a basic, empty layout – empty -tiles in 2 lines with 4 columns each. If you want to modify them, create a -"clean" config, where your changes will be introduced. Use the command:: +First thing that you need to do after successfull installation is to create an +empty config that will provide a base for your customizations. Type in this +command:: (tb-env)$ tipboard create_project -It will create the ``~/.tipboard`` dir with the following content: +It will create ``~/.tipboard`` directory with the following content: * ``settings-local.yaml`` file that defines the layout of tiles on the dashboard you are creating; @@ -35,8 +35,7 @@ It will create the ``~/.tipboard`` dir with the following content: Launching Tipboard app ---------------------- -After you have logged in to your machine, you may launch Tipboard with the -command:: +Having default config in place, you may launch Tipboard with the command:: (tb-env)$ tipboard runserver [] [] @@ -44,6 +43,9 @@ command:: ``localhost`` and ``7272``; if you want the application to listen on all the network interfaces, set ``host`` to ``0.0.0.0``). +You can now point your web browser to ``http://localhost:7272`` - you should +see a basic, empty layout with tiles in 2 lines of 4 columns each. + Customising tile layout ----------------------- @@ -137,7 +139,7 @@ One of the most useful functions is defining tiles to rotate. In a single container (i.e. in one of the fields indicated by ``col_X_of_Y`` and ``row_X_of_Y``), you may define a few tiles to be displayed in this location as items rotating at intervals defined in the configuration (similar to ads -rotating on bus/tram stops, so-called *citylights*). To achieve that: +rotating on bus/tram stops, so-called citylights). To achieve that: * add the ``flip-time-xx`` class to a container, where ``xx`` is rotation interval in seconds; @@ -239,3 +241,8 @@ this behavior and rotate only certain dashboards, just add another parameter taken into account, e.g.:: FLIPBOARD_SEQUENCE = ['my_first_dashboard', 'my_third_dashboard'] + +.. note:: + + Every change in ``settings-local.py`` file requires restart of the + application. -- cgit v1.2.3