Improving "The Quick Tour" tutorial #3562
Conversation
…g Picture" chapter
added a section about displaying error pages
|
You should resize the images to make them width 600px, otherwise there are rendering issues on symfony.com and in the pdf And you are missing the PR format in your PR description :) |
| web/ | ||
| app.php | ||
| ... | ||
| $ composer create-project symfony/framework-standard-edition myproject/ ~2.4 |
There was a problem hiding this comment.
I prefer to remove the trailing slash.
There was a problem hiding this comment.
My reasoning for this: myproject can be a file name, a dir name, a configuration option name, etc. But myproject/ is easily understood as a dir path.
There was a problem hiding this comment.
In the paragraph before this code, you already say "the following command to install the latest version of Symfony2 in the myproject/ directory" (I would also vote to remove it there). As there is only one occurence of "myproject" in the command, it's already very clear that it's the directory name
There was a problem hiding this comment.
I like using the slash too in this way :)
| controller if a variable is type hinted with | ||
| `Symfony\Component\HttpFoundation\Request`:: | ||
| Symfony automatically injects the ``Request`` object when the controller defines | ||
| a variable type hinted with `Symfony\Component\HttpFoundation\Request`:: |
There was a problem hiding this comment.
I think this sounds a little friendlier:
... ``Request`` object when the controller has an argument that's type hinted with ...
|
@javiereguiluz I just added a few more comments (I hadn't read through everything yet) - but it's fantastic! Definitely a great facelift! After those few small changes, I'll merge this in :). Thanks! |
|
@weaverryan and @wouterj thank you very much for your reviews! |
| The controller first bootstraps the application using a kernel class (``AppKernel`` | ||
| in this case). Then, it creates the ``Request`` object using the PHP's global | ||
| variables and passes it to the kernel. The last step is to send back to the user | ||
| the response contents returned by the kernel. |
There was a problem hiding this comment.
I feel that The last step is to send the response contents returned by the kernel back to the user.
|
@xabbuh thanks for your fixes! |
| @@ -119,14 +112,14 @@ a single ``Bundle`` class that describes it:: | |||
|
|
|||
| In addition to the AcmeDemoBundle that was already talked about, notice | |||
| that the kernel also enables other bundles such as the FrameworkBundle, | |||
| DoctrineBundle, SwiftmailerBundle, and AsseticBundle bundle. | |||
| They are all part of the core framework. | |||
| DoctrineBundle, SwiftmailerBundle, and AsseticBundle bundle. They are all part | |||
There was a problem hiding this comment.
The comma after SwiftmailerBundle should be removed.
| @@ -268,7 +261,7 @@ Extending Bundles | |||
|
|
|||
| If you follow these conventions, then you can use :doc:`bundle inheritance</cookbook/bundles/inheritance>` | |||
| to "override" files, controllers or templates. For example, you can create | |||
| a bundle - ``AcmeNewBundle`` - and specify that it overrides AcmeDemoBundle. | |||
| a bundle - AcmeNewBundle - and specify that it overrides AcmeDemoBundle. | |||
There was a problem hiding this comment.
Maybe we shouldn't say that a bundles overrides another bundle but instead extends a parent bundle?
There was a problem hiding this comment.
No, we have explicitely changed this from parent to override (one of my first doc contributions) as there is no parent/child relation, the getParent method is confusing and only there as it means a big BC change.
More information in symfony/symfony#4347 and the related doc PR and fabian's commit
There was a problem hiding this comment.
Ah, thanks for the clarification.
|
This is definitely ready to go - but we need to merge it into the 2.3 branch (especially since it's a LTS release) - I've rebased and opened up #3613 for that. I don't think we need any tweaks - I'll just leave it up briefly before merging for a sanity check. Closing this in favor of that PR. Thanks! |
This PR was merged into the 2.3 branch. Discussion ---------- Javiereguiluz revamped quick tour Hey guys! See #3562 - this is the same, but rebased against the 2.3 branch. | Q | A | ------------- | --- | Doc fix? | no | New docs? | yes | Applies to | 2.3+ | Fixed tickets | Off of the top of my head (but I could be wrong), the only thing that was 2.4 specific is the version number used in the composer.phar create-project command. We could fix this in 2 different ways: 1) Don't fix it - just always keep that number updated to the latest released version. We do this similarly in other places 2) Use "@stable" as the version constraint. I don't know of any drawbacks. Thanks! Commits ------- 1e36cfa [quick_tour] rewording and grammar fixes noted by @xabbuh 69fdff1 [quick_tour] removed an unneeded comma 30624eb [quick_tour] more rewording and grammar fixes 0f13ce9 [quick_tour] rewording and grammar fixes suggested by @weaverryan 7c0037e Restored all the original introductions for each tutorial part cb98a6c Restored the original line that explained how a routing file is imported from a bundle fdc755e Grammar fixes proposed by @weaverryan and @wouterj eca1e73 Added a more useful message for users that don't have PHP 5.4 and try to execute the server:run command a013b11 Removed the animated GIF showing how to install Symfony 985c68f Replaced "variable" by "placeholder" when using {_format} inside a route 42bd69f Fixed the capitalization of a section heading 75be815 Minor rewording c1ad15d Added a new headline to better structure the documentation b16c3a2 Capitalized some sentences that come after a colon 2fdcffd When using server:run command, it's not necessary to add the `app_dev.php` controller 6afc80b Removed a wrongly inserted comma e004661 Bundle names should not be placed in literals 38b1292 [quick_tour] removed inline links 81d6e20 [quick_tour] replaced "chapter" by "part" in some tutorial parts 50e136c [quick_tour] second pass to "the architecture" chapter cdb7064 [quick_tour] second pass to "the controller" chapter and added a section about displaying error pages 2cd3bab [quick tour] second pass to "the view" chapter 4ad3c44 [quick_tour] second pass to the "big picture" chapter e7dfc8b [quick_tour] simplified "the architecture" chapter eb3fe4c [quick tour] simplified "the controller" chapter dbbc8c2 [quick_tour] updated "the view" chapter 5b3a572 [quick_tour] finished the review of "The Big Picture" chapter f24eabc [quick_tour] updated some screenshots 20e9fb0 [quick_tour] updated the "Controllers" section 29992cd [quick_tour] simplified the "routing" section a84a556 [quick_tour] simplified drastically the first two sections of "The Big Picture" chapter
This pull request tries to improve the current Quick Tour tutorial. Instead of updating its contents, this is a complete revamp of the original tutorial:
Before adding comments and corrections for this proposal, please keep in mind that this tutorial is for the absolute Symfony beginner and that it should provide just a brief tour of the most important Symfony features.