[quick tour] updating the quick tour #802

dbu · 2017-01-25T16:15:05Z

removed references to createjs
changed code to follow best practices
replace references to simplecms
check if the walkthrough still works with the cmf ~~standard edition~~ sandbox, or if we first need to create some more things now.

fix #788

dbu · 2017-01-25T16:15:56Z

or should we use the sandbox for the quick tour to avoid having to set up an AppBundle and such stuff?

wouterj · 2017-01-27T23:11:38Z

or should we use the sandbox for the quick tour to avoid having to set up an AppBundle and such stuff?

That's what I had in mind. Imo, people should mostly look in the quick tour, not write.

dbu · 2017-01-28T07:54:39Z

good. i will see what i can do tomorrow on the train

dbu · 2017-01-31T07:59:39Z

quick_tour/the_model.rst

+    public function load(ObjectManager $documentManager)
+    {
+        // ...
+        $route = new Route();


should we do all this in the model chapter, or rather just show the node dump here, and go to the route chapter for adding the route?

dbu · 2017-01-31T07:59:52Z

quick_tour/the_model.rst

-        $page->setName('new_page'); // the name of the node
+        $page->setName('quick-tour'); // the name of the node
+
+        vno sandbox übernehmen


i need to update the code here.

dbu · 2017-01-31T08:01:01Z

quick_tour/the_third_party_bundles.rst

@@ -157,6 +131,8 @@ more SEO information.
 Sonata Admin
 ------------

+TODO: rewrite for sonata admin integration split out


this says todo...

dbu · 2017-03-06T07:38:21Z

this is ready for final review. glad for input, i might have missed places but don't see it anymore after having gone over it several times...

dbu · 2017-03-19T09:10:32Z

ping @wouterj do you want to review this or should i just merge it?

wouterj

Very nice job! Just read everything and commented on some things, but looks perfect in general.

wouterj · 2017-03-19T11:08:16Z

quick_tour/the_big_picture.rst

@@ -25,36 +25,31 @@ the core parts of the CMS.

 The CMF is created to solve this framework versus CMS dilemma. It provides
 bundles, so you can easily add CMS features to your project. But it also
-provides flexibility and in all cases you are using the framework, so you can
+provides flexibility and you can use the underlying Symfony framework to
 build custom functionality the way you want. This is called a `decoupled CMS`_.


I agree that my previous sentence was all but correct, but let's improve it even more. Maybe something like:

The Symfony CMF is created to solve this framework versus CMS dilemma. It provides bundles, so you can easily add CMS features to your project. Yet, as you're still using the Symfony framework, you can build any custom functionality you can think of. This flexibility is called a `decoupled CMS`_.

wouterj · 2017-03-19T11:09:44Z

quick_tour/the_big_picture.rst

 build custom functionality the way you want. This is called a `decoupled CMS`_.

 The bundles provided by the Symfony CMF can work together, but they are also
 able to work standalone. This means that you don't need to add all bundles, you
-can decide to only use one of them (e.g. only the RoutingBundle or the MediaBundle).
+can decide to only use one of them (e.g. only the RoutingBundle or the SeoBundle).


Hmm, SeoBundle is just the one bundle that doesn't work standalone nicely :). Maybe leave out the second example here?

wouterj · 2017-03-19T11:12:05Z

quick_tour/the_big_picture.rst

 extension. After that, run these commands:

 .. code-block:: bash

+    $ cd cmf-sandbox
+    $ cp app/config/phpcr_doctrine_dbal.yml.dist app/config/phpcr.yml


In Windows, cp is not available by default. Maybe we should add a comment about it:

$ cd cmf-sandbox $ cp app/config/phpcr_doctrine_dbal.yml.dist app/config/phpcr.yml # Or when you're on a Windows PC: # $ copy app\config\phpcr_doctrine_dbal.yml.dist app\config\phpcr.yml $ php bin/console doctrine:database:create [...]

wouterj · 2017-03-19T11:12:53Z

quick_tour/the_big_picture.rst

-content is updated.
+Now you know the request flow, you can start editing content. While the normal
+usage will be to edit content through a web interface, the CMF sandbox also
+supports  loading content from static files. This is mainly useful for testing


double space after "supports"

wouterj · 2017-03-19T11:15:22Z

quick_tour/the_model.rst

-time, you'll create a page by doing it yourself.
+Now that you know a little bit more about PHPCR and you know the tool to interact
+with it, you can start using it yourself. In the previous chapter, you edited
+a page by using a yaml file which was parsed by the fixture loader of the


"a Yaml file"

wouterj · 2017-03-19T11:19:05Z

quick_tour/the_router.rst

-configuration or by tagging the router services. For instance, the router used
-by the SimpleCmsBundle is a service registered by that bundle and tagged with
-``cmf_routing.router``.
+You see that a route like ``/company/team``, which consist of 2 "path units",


wouterj · 2017-03-19T11:19:13Z

quick_tour/the_router.rst

-by the SimpleCmsBundle is a service registered by that bundle and tagged with
-``cmf_routing.router``.
+You see that a route like ``/company/team``, which consist of 2 "path units",
+has 2 documents in the PHPCR tree: ``company`` and ``team``.


wouterj · 2017-03-19T12:09:37Z

quick_tour/the_third_party_bundles.rst

 contains all items implementing the ``NodeInterface`` inside the
-``/cms/simple`` (since the basepath in the Standard Edition is ``/cms``).
+``/cms/menu/main`` (since the basepath in the CMF Sandbox is ``/cms/menu``).


"inside the /cms/menu/main path"

wouterj · 2017-03-19T12:11:12Z

quick_tour/the_third_party_bundles.rst

 persisted using PHPCR, it also needs a block document, which is located in
-``Acme\DemoBundle\Document\UnitBlock``.
+``AppBundle\Document\UnitBlock``.


Hmm, this paragraph is no longer true, is it? Maybe comment it out for now and add this block when reworking the CMF sandbox (nr. 1 priority for me after 2.0 stable).

i removed the part about the blocks being custom blocks because that is no longer true. but we do show blocks on the homepage of the sandbox.

wouterj · 2017-03-19T12:15:35Z

quick_tour/the_third_party_bundles.rst


-You can also disable/enable all CMF Admin classes by configuring this on the
-``cmf_core`` bundle:
+By default, the Admin classes for the CMF bundles that are installed are activated.


It's the other way around: By default, all admins are disabled. Should we change that in the integration bundle?

ah, you are right. i would say lets keep it that way. otherwise adding new admins would have to be considered a BC break, or we would have to be inconsistent when adding new admins. i adjusted the doc

dbu · 2017-03-20T07:58:03Z

thanks for the feedback. pushed an update that should adress all of this.

dbu added wip/poc labels Jan 25, 2017

dbu mentioned this pull request Jan 25, 2017

Throughly review Quick Tour #788

Closed

3 tasks

dbu force-pushed the best-practices-quick-tour branch from 9ed0555 to 8cf24b4 Compare January 26, 2017 09:15

dbu commented Jan 31, 2017

View reviewed changes

dbu added 2 commits March 5, 2017 10:31

started updating the tutorial

1db138f

WIP rewrite quick tour to sandbox

8e49370

dbu force-pushed the best-practices-quick-tour branch from 574dfb2 to 8e49370 Compare March 5, 2017 09:31

dbu changed the base branch from master to 2.0 March 5, 2017 09:32

dbu changed the title ~~WIP [quick tour] updating the quick tour~~ [quick tour] updating the quick tour Mar 6, 2017

dbu force-pushed the best-practices-quick-tour branch 2 times, most recently from 6908096 to f4b71b9 Compare March 6, 2017 07:43

wouterj reviewed Mar 19, 2017

View reviewed changes

dbu force-pushed the best-practices-quick-tour branch from f4b71b9 to a63ce48 Compare March 20, 2017 07:56

wrap up rewriting the quick tour

ba4955a

dbu force-pushed the best-practices-quick-tour branch from a63ce48 to ba4955a Compare March 20, 2017 08:20

wouterj merged commit 6307df0 into 2.0 Apr 2, 2017

wouterj deleted the best-practices-quick-tour branch April 2, 2017 00:45

wouterj removed the wip/poc label Apr 2, 2017

dbu mentioned this pull request Aug 20, 2017

Review Quick Tour #827

Closed

2 tasks

[quick tour] updating the quick tour #802

[quick tour] updating the quick tour #802

Uh oh!

Conversation

dbu commented Jan 25, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dbu commented Jan 25, 2017

Uh oh!

wouterj commented Jan 27, 2017

Uh oh!

dbu commented Jan 28, 2017 via email

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dbu commented Mar 6, 2017

Uh oh!

dbu commented Mar 19, 2017

Uh oh!

wouterj left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dbu commented Mar 20, 2017

Uh oh!

Uh oh!

dbu commented Jan 25, 2017 •

edited

Loading