From 7e5945d6a1d84bf8050c3c095cc64b26881bdb98 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Thu, 4 Dec 2014 16:41:46 +0100 Subject: [PATCH] improve documentation hierarchy We create a level into the "installation" directory, and create an index file into this directory. This will also be more consistent with the "developer" part. --- source/index.rst | 3 +-- source/installation/index.rst | 32 ++++++++++++++++++++++++++++ source/installation/installation.rst | 7 +++++- 3 files changed, 39 insertions(+), 3 deletions(-) create mode 100644 source/installation/index.rst diff --git a/source/index.rst b/source/index.rst index 32b8f4d4a..a7db0cb28 100644 --- a/source/index.rst +++ b/source/index.rst @@ -23,8 +23,7 @@ Contents of this documentation: .. toctree:: :maxdepth: 2 - installation/installation.rst - installation/install_new_bundles.rst + installation/index.rst development/index.rst diff --git a/source/installation/index.rst b/source/installation/index.rst new file mode 100644 index 000000000..099628e02 --- /dev/null +++ b/source/installation/index.rst @@ -0,0 +1,32 @@ +.. chill-doc documentation master file, created by + sphinx-quickstart on Sun Sep 28 22:04:08 2014. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +.. Copyright (C) 2014 Champs Libres Cooperative SCRLFS + Permission is granted to copy, distribute and/or modify this document + under the terms of the GNU Free Documentation License, Version 1.3 + or any later version published by the Free Software Foundation; + with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. + A copy of the license is included in the section entitled "GNU + Free Documentation License". + +Instructions about installation +################################ + +You will learn here : + +.. toctree:: + :maxdepth: 2 + + How to install the software + Add new bundles to your installation + + +.. todo:: + + We should write a section on "how to update your installation". + +.. todo:: + + We should write a section on "what are the concepts of chill" and explain what is a bundle, why we should install it, how to find them, ... diff --git a/source/installation/installation.rst b/source/installation/installation.rst index e1407f4ce..4aa05a50c 100644 --- a/source/installation/installation.rst +++ b/source/installation/installation.rst @@ -92,6 +92,12 @@ Create your Chill project using composer: php composer.phar create-project chill-project/standard \ path/to/your/directory --stability=dev +You should, now, move your cursor to the new directory + +.. code-block:: bash + + cd path/to/your/directory + .. note:: Until now, the stability of the project is set to "dev". Do not forget this argument, or composer will fail to download and create the project. @@ -170,7 +176,6 @@ If everything was fine, you are able to launch your built-in server : .. code-block:: bash - cd path/to/your/directory php app/console server:run Your server should now be available at `http://localhost:8000`. Type this address on your browser and you should see the homepage.