[4.0] Setup & Page Creation updates #8544

weaverryan · 2017-10-24T13:02:21Z

Hi guys!

I'm currently re-reading the most important changes and updating for 4.0 (probably, we need to do a scripted find-replace for the biggest changes (e.g. AppBundle -> App, app/config/config.yml to... other things) for the bulk of the chapters.

I'm already continuing with routing and other chapters, but wanted to get this PR at least submitted as soon as possible.

javiereguiluz

Nice changes! Thanks for this.

javiereguiluz · 2017-10-24T13:07:34Z

page_creation.rst

+        resource: ../src/Controller/
+        type: annotation
+
+After this one-time setup, you can nowadd your route directly *above* the controller:


nowadd -> now add

javiereguiluz · 2017-10-24T13:08:39Z

page_creation.rst

+
+Second, after this package was downloaded, Flex executed a *recipe*, which automatically
+enabled the bundle. Flex recipes exist for many packages (not just bundles) and have
+have the ability to do a lot, like adding configuration files, creating directories,


have is repeated at the end of the previous line.

javiereguiluz · 2017-10-24T13:11:12Z

page_creation.rst

-Finally, template files should live in the ``app/Resources/views`` directory. Create
-a new ``app/Resources/views/lucky`` directory with a new ``number.html.twig`` file
-inside:
+Template files live in the ``templates/`` directory, which was created for your automatically


for your -> for you

javiereguiluz · 2017-10-24T13:12:09Z

page_creation.rst

-    that is *not* PHP code goes here.
+``config/``
+    Contains... configuration of course!. You will configure routes, :doc:`services </service_container>`
+    and pckages.


pckages -> packages

javiereguiluz · 2017-10-24T13:13:41Z

page_creation.rst

 ``var/``
    This is where automatically-created files are stored, like cache files
-    (``var/cache/``), logs (``var/logs/``) and sessions (``var/sessions/``).
+    (``var/cache/``) and logs (``var/logs/``).


Be careful!! var/logs/ is now called var/log/ See symfony/recipes#169

Oh! I hadn't even realized! Thanks :)

do you need some hand? see #8547 ;)

javiereguiluz · 2017-10-24T13:16:02Z

setup.rst

-cache, logs) to the repository, so you'll have to do the following when
-installing an existing Symfony application:
+If you're working on an existing Symfony application, you'll just need to do a few
+things to get your project setup. Assuming your team uses git, you can setup your


git -> Git

javiereguiluz · 2017-10-24T13:21:07Z

page_creation.rst

@@ -65,44 +60,154 @@ random) number and prints it. To do that, create a "Controller class" and a
        }
    }

-Before diving into this, test it out! If you are using PHP's internal web server
-go to:
+To map a URL to this controller, create a route in ``config/routes.yaml``:


I just wonder if this is too advanced to be understood by someone who is starting with Symfony:

To map a URL to this controller, create a route in ``config/routes.yaml``:

Would something like this be better ... or just more verbose and complicated?

Now you need to associate this controller with a public URL so the ``number()`` method is executed when users browse some URL (e.g. ``/lucky/number``). This association is defined creating a **route** in the ``config/routes.yaml`` file:

javiereguiluz · 2017-10-24T13:25:10Z

page_creation.rst

+First, ``annotations`` isn't a real package name: it's an *alias* (i.e. shortcut)
+that Flex resolves to ``sensio/framework-extra-bundle``.
+
+Second, after this package was downloaded, Flex executed a *recipe*, which automatically


In this paragraph I'm missing a simple description of what a recipe is. If you agree, I propose something like: "a set of automated instructions that tell Symfony how to integrate some external package".

Besides, this paragraph is the only one mentioning "bundles" ... and it's strange because we don't introduce that concept anywhere in this article. I propose to remove all references about bundles.

So this is how it'd look:

Second, after this package was downloaded, Flex executed a *recipe*, which is a set of automated instructions that tell Symfony how to integrate some external package. Flex recipes exist for many packages and have the ability to do a lot, like adding configuration files, creating directories, updating ``.gitignore`` and adding new config to your ``.env`` file. Flex *automates* the installation of packages so you can get back to coding.

weaverryan · 2017-10-24T13:40:54Z

configuration.rst

+There is also a ``.env`` file which is loaded. Its contents become environment variables
+in the dev environment, making it easier to reference environment variables in your
+code.
+


This will be covered more #8546. I just bootstrapped this section so that I could link to it.

weaverryan · 2017-10-24T13:41:27Z

All comments addressed!

javiereguiluz · 2017-10-24T13:52:04Z

page_creation.rst

+
+Second, after this package was downloaded, Flex executed a *recipe*, which is a
+set of automated instructions that tell Symfony how to integrate an external
+package. Flex recipes exist for many packages (not just bundles) and have the


One last comment on my side. In this paragraph we mention "bundles" for the first time and without prior introduction ("[...] Flex recipes exist for many packages (not just bundles) and have [...]"). Given that bundles are not important in this article, we could remove this mention. Thanks!

wouterj

Mostly minor CS things

wouterj · 2017-10-25T22:08:09Z

page_creation.rst

+
+    $ composer require annotations
+
+Then, in ``config/routes.yaml``, remove the route we just created and uncomment


No first person in the docs

wouterj · 2017-10-25T22:08:29Z

page_creation.rst

+.. code-block:: diff
+
+    // src/Controller/LuckyController.php
+    // ...


this and the empty line below should be swapped (minor)

wouterj · 2017-10-25T22:09:44Z

page_creation.rst

+you can get back to coding.
+
+You can learn more about Flex by reading ":doc:`/setup/flex`". But that's not necessary:
+Flex works automatically in the background when you add packages.


This is probably the time to link to http://symfony.sh ?

wouterj · 2017-10-25T22:09:55Z

page_creation.rst

+You can learn more about Flex by reading ":doc:`/setup/flex`". But that's not necessary:
+Flex works automatically in the background when you add packages.
+
+The bin/console Utility


The console utility?

wouterj · 2017-10-25T22:10:09Z

page_creation.rst

+
+.. code-block:: terminal
+
+    php bin/console


Commands have to be prefixed by $ (otherwise, the parser won't understand it)

wouterj · 2017-10-25T22:10:21Z

page_creation.rst

+
+.. code-block:: terminal
+
+    php bin/console debug:router


carsonbot added the Status: Needs Review label Oct 24, 2017

javiereguiluz approved these changes Oct 24, 2017

View reviewed changes

javiereguiluz reviewed Oct 24, 2017

View reviewed changes

weaverryan commented Oct 24, 2017

View reviewed changes

weaverryan added this to the 3.4 milestone Oct 24, 2017

javiereguiluz reviewed Oct 24, 2017

View reviewed changes

javiereguiluz added Status: Reviewed and removed Status: Needs Review labels Oct 24, 2017

wouterj requested changes Oct 25, 2017

View reviewed changes

weaverryan added 6 commits October 28, 2017 21:52

WIP

57918e4

updating page_creation and setup for 4.0

efb7b50

Changes thanks to Javier

5cd1e20

Fixing build issues

f727f17

last tweaks

771f41c

Fixes thanks to Wouter

17d1a10

weaverryan closed this in 679b46c Oct 29, 2017

weaverryan deleted the new-flex-setup branch October 29, 2017 02:24

javiereguiluz mentioned this pull request Nov 26, 2017

Updating docs to Symfony 4 and Symfony Flex #8754

Closed


		$ composer require annotations

		Then, in ``config/routes.yaml``, remove the route we just created and uncomment

Uh oh!

[4.0] Setup & Page Creation updates #8544

[4.0] Setup & Page Creation updates #8544

Uh oh!

Conversation

weaverryan commented Oct 24, 2017

Uh oh!

javiereguiluz 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!

javiereguiluz Oct 24, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

weaverryan commented Oct 24, 2017

Uh oh!

Choose a reason for hiding this comment

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!

Uh oh!

javiereguiluz Oct 24, 2017 •

edited

Loading