Chill-project/chill-bundles
6
0
Fork 0
mirror of https://gitlab.com/Chill-Projet/chill-bundles.git synced 2025-06-12 21:34:25 +00:00
Code Issues Actions Projects Releases Wiki Activity

improve documentation hierarchy

Browse Source 
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.
This commit is contained in:
Julien Fastré 2014-12-04 16:41:46 +01:00
parent cc6326bc15
commit 7e5945d6a1
3 changed files with 39 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
source/index.rst
View File

@ -23,8 +23,7 @@ Contents of this documentation:
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
installation/installation.rst installation/index.rst
installation/install_new_bundles.rst
development/index.rst development/index.rst

32
source/installation/index.rst Normal file
View File

@ -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 <installation.rst>
Add new bundles to your installation <install_new_bundles.rst>
.. 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, ...

7
source/installation/installation.rst
View File

@ -92,6 +92,12 @@ Create your Chill project using composer:
php composer.phar create-project chill-project/standard \ php composer.phar create-project chill-project/standard \
path/to/your/directory --stability=dev 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:: .. 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. 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 .. code-block:: bash
cd path/to/your/directory
php app/console server:run 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. Your server should now be available at `http://localhost:8000`. Type this address on your browser and you should see the homepage.