Skip to content
This repository was archived by the owner on Sep 16, 2021. It is now read-only.

Commit 5f743bc

Browse files
committed
Merge pull request #358 from symfony-cmf/start_quick_tour
[WIP] The Quick Tour
2 parents b404bd0 + 772232f commit 5f743bc

14 files changed

+775
-36
lines changed
72.8 KB
Loading
8.72 KB
Loading
44.1 KB
Loading
40.1 KB
Loading
38.1 KB
Loading

_images/quick_tour/request_flow.png

35.4 KB
Loading
37.9 KB
Loading

index.rst

Lines changed: 22 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -3,54 +3,41 @@ Symfony CMF Documentation
33

44
The Symfony2 Content Management Framework (CMF) project is organized by the Symfony
55
community and has several sponsoring companies and prominent open source leaders
6-
implementing the philosophy of the `decoupled CMS`_. You can learn more about the
7-
project on the `about`_ page.
6+
implementing the philosophy of the `decoupled CMS`_.
87

9-
This documentation is still in development. The bundles and reference sections
10-
are updated for the 1.0 release, but the book is still a bit sparse. Want to
11-
help? Thank you, all help greatly appreciated! The source of the
12-
`documentation is hosted on github`_.
8+
.. caution::
139

14-
Mission Statement
15-
-----------------
16-
17-
The Symfony CMF project makes it easier for developers to add CMS functionality to
18-
applications built with the Symfony2 PHP framework. Key development principles for
19-
the provided set of bundles are scalability, usability, documentation and testing.
20-
21-
Why another CMS?
22-
----------------
23-
24-
Actually we consider this project to be a CMF, a **content management framework**, rather
25-
than a CMS, a content management system. The reason is that we are only **providing the tools
26-
to build a custom CMS**. There are clearly many CMS solutions available already,
27-
but they tend to be monolithic packages tailored towards end users. Many carry a certain
28-
amount of legacy baggage which make them less than **ideal for developing highly
29-
custom applications**, in contrast to what is possible with `Symfony2`_.
30-
31-
What is our target audience?
32-
----------------------------
33-
34-
There are basically two main target audiences:
35-
36-
#. Developers who have built an existing custom application with Symfony2 and need a fast
37-
way to add support for content management. Be it sophisticated CMS features like semantic
38-
content, inline editing, multi-channel delivery etc. or just a few content pages for things
39-
like the about/contact pages.
40-
41-
#. Developers that need to build a highly customized authoring and content delivery
42-
solution that no out-of-the-box CMS can properly provide through customization alone.
10+
This documentation is still in development. The bundles and reference sections
11+
are updated for the 1.0 release, but the book is still a bit sparse. Want to
12+
help? Thank you, all help greatly appreciated! The source of the
13+
`documentation is hosted on github`_.
4314

4415
.. toctree::
4516
:hidden:
4617

18+
quick_tour/index
4719
book/index
4820
bundles/index
4921
components/index
5022
contributing/index
5123
reference/index
5224
cookbook/index
5325

26+
Quick Tour
27+
----------
28+
29+
The best way to get started with the Symfony CMF is by reading the Quick Tour.
30+
This will guide you through the code, philosophy and architecture of the
31+
Symfony CMF project.
32+
33+
.. toctree::
34+
:maxdepth: 1
35+
36+
quick_tour/the_big_picture
37+
quick_tour/the_model
38+
quick_tour/the_router
39+
quick_tour/the_third_party_bundles
40+
5441
Book
5542
----
5643

@@ -110,7 +97,6 @@ Do you want to contribute to the Symfony CMF? Start reading these articles!
11097

11198
.. _`decoupled CMS`: http://decoupledcms.org
11299
.. _`Symfony2`: http://symfony.com
113-
.. _`about`: http://cmf.symfony.com/about
114100
.. _`Documentation planning`: https://github.com/symfony-cmf/symfony-cmf/wiki/Documentation-Planning
115101
.. _`Symfony Content Management Framework`: http://cmf.symfony.com
116102
.. _`documentation is hosted on github`: https://github.com/symfony-cmf/symfony-cmf-docs

quick_tour/index.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
The Quick Tour
2+
==============
3+
4+
.. toctree::
5+
:hidden:
6+
7+
the_big_picture
8+
the_model
9+
the_router
10+
the_third_party_bundles
11+
12+
.. include:: map.rst.inc

quick_tour/map.rst.inc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
* :doc:`the_big_picture`
2+
* :doc:`the_model`
3+
* :doc:`the_router`
4+
* :doc:`the_third_party_bundles`

0 commit comments

Comments
 (0)