The New Quick Tour #8892
The New Quick Tour #8892
Conversation
quick_tour/the_big_picture.rst
Outdated
|
|
||
| If you've used a web framework before, you should feel right at home with | ||
| Symfony. If not, welcome to a whole new way of developing web applications. | ||
| Symfony. If not, welcome to a whole new way of developing web applications. Symfony | ||
| *embraces* best practices, keeps backwards compatbility (Yes! Upgrading is always |
quick_tour/the_big_picture.rst
Outdated
| user's requests and that code is defined via the **routing** configuration. | ||
| And the contents displayed in the browser are usually rendered using | ||
| **templates**. | ||
| This creates a new ``quick_tour/`` directory with, at first, just *one* file: |
There was a problem hiding this comment.
I find this explanation about having just 1 file called composer.json confusing. Users won't ever see this single file but the entire project files, so I'd recommend to remove this.
quick_tour/the_big_picture.rst
Outdated
|
|
||
| Actions and Controllers | ||
| ~~~~~~~~~~~~~~~~~~~~~~~ | ||
| Where did these files come from? They came from recipes installed by Symfony Flex. |
There was a problem hiding this comment.
I think it's too early to mention concepts like Flex and recipes. They run a "create-project" command and they got a project created. That's intuitive. If we add this mention to Flex/recipes, things complicate without a clear benefit.
quick_tour/the_big_picture.rst
Outdated
| Can we already load the project in a browser? Of course! You can setup | ||
| :doc:`Nginx or Apache <setup/web_server_configuration>` and configure their document | ||
| root to be the ``public/`` directory. But, for development, Symfony has its own server. | ||
| Install it with: |
There was a problem hiding this comment.
Install it and run it with: ?
quick_tour/flex_recipes.rst
Outdated
| After reading the first part of this tutorial, you have decided that Symfony was | ||
| worth another 10 minutes. Great choice! In this second part, you'll learn about | ||
| Symfony Flex: the amazing tool that makes adding new features as simple as running | ||
| one command. It's also the reason why Symfony is perfect for a small micro-service |
There was a problem hiding this comment.
Just asking: can this sound arrogant? --> "[...] Symfony is perfect for [...]" Could we reword it?
quick_tour/flex_recipes.rst
Outdated
| files. Thanks to recipes, adding features is seamless and automated: install a package | ||
| and you're done! | ||
|
|
||
| You an find a full list of recipes and aliases by going to `https://symfony.sh`_. |
There was a problem hiding this comment.
typo: an find -> can find
quick_tour/flex_recipes.rst
Outdated
|
|
||
| You an find a full list of recipes and aliases by going to `https://symfony.sh`_. | ||
|
|
||
| What did this recipe do? In addition to automatically enabling the bundle in |
There was a problem hiding this comment.
"enabling the bundle" <-- will people understand that? It's the first time that "bundle" is mentioned in the Quick Tour. Maybe: "enabling the feature" is better?
quick_tour/flex_recipes.rst
Outdated
| A configuration file that sets up Twig with sensible defaults. | ||
|
|
||
| ``config/routes/dev/twig.yaml`` | ||
| A route that helps you debug your error pages: it's added only in the ``dev`` |
There was a problem hiding this comment.
This is the first time that "environment" is mentioned. Maybe we can remove this entirely -> "it's added only in the dev environment."
quick_tour/flex_recipes.rst
Outdated
| $ composer require profiler | ||
|
|
||
| Yes! This is another alias! And Flex *also* installs another recipe, which automates | ||
| the configuration of Symfony's WebProfilerBundle. What's the result? Refresh! |
There was a problem hiding this comment.
I'd prefer to never mention bundles in the Quick tour. What if we replace Symfony's WebProfilerBundle by Symfony's Profiler ?
quick_tour/flex_recipes.rst
Outdated
| Flex will *uninstall* the recipes: removing files and un-doing changes to put your | ||
| app back in its original state. Experiment without worry. | ||
|
|
||
| More Feature, Architecture and Speed |
There was a problem hiding this comment.
typo? More Feature, ... -> More Features, ...
|
Thanks for the fast review Javier! And now it's fully finished and the last chapter is ready for review :) |
quick_tour/the_architecture.rst
Outdated
| // ... | ||
| } | ||
|
|
||
| That's it! The new log message be written to ``var/log/dev.log``. Of course, this |
There was a problem hiding this comment.
message be written -> message will be written ?
quick_tour/the_architecture.rst
Outdated
|
|
||
| Every bit of work that's done in a Symfony app is done by an *object*: the Logger | ||
| object logs things and the Twig object renders templates. These objects are called | ||
| *services* and they are the *tools* that make you dangerous. |
There was a problem hiding this comment.
I'm not sure this "dangerous" word is going to be understood well by people with basic English level, which are most of our readers. Why if we say something easier to understand, like: "...the tools that give you super powers!"
quick_tour/the_architecture.rst
Outdated
| } | ||
| } | ||
|
|
||
| Yes! This works too: no configuration, no time wasted. |
There was a problem hiding this comment.
no configuration -> no service configuration needed or something like that?
|
Changes made! |
This PR was squashed before being merged into the 4.0 branch (closes #8892). Discussion ---------- The New Quick Tour Fixes #8884 Hi guys! The quick tour will now be 3 parts (instead of 4), and I've finished the first 2 parts. I'm purposely using the first person point of view and more conversational language. Cheers! Commits ------- e2a9b82 tweaks thanks to Javier 3beccde Comments thanks to Javier and fixing build issues a1b02e9 adding progress b0d46e5 WIP - 2/3 parts of the quick tour finished
Fixes #8884
Hi guys!
The quick tour will now be 3 parts (instead of 4), and I've finished the first 2 parts. I'm purposely using the first person point of view and more conversational language.
Cheers!