Removed the Internals chapter from the Symfony book #4901
Conversation
|
So we basically already have this info, we maybe just have to group them on a bit more logical place (the list in full dic_tags isn't a very nice location imo). |
| .. index:: | ||
| single: Profiler; Using the profiler service | ||
|
|
||
| Accessing the Profiling information |
There was a problem hiding this comment.
do we have this convered somewhere? If not, we should create a cookbook article (or add it to an existing one).
There was a problem hiding this comment.
Good idea! I've created the cookbook here: 7a833ef
|
@wouterj considering your comments, maybe the best thing is to actually create that new reference document to group all events. |
|
Should the redirection map be updated to avoid having a 404 on this URL ? |
|
@stof Good idea! I've just added a redirection to the new events reference document. |
| :method:`Symfony\\Component\\HttpKernel\\Profiler\\Profiler::loadProfileFromResponse` | ||
| method to access to its associated profile:: | ||
|
|
||
| $profile = $container->get('profiler')->loadProfileFromResponse($response); |
There was a problem hiding this comment.
we should not advocate the usage of $contaier->get() imo. It also doesn't tell important information, such as: Where should I place this?
There was a problem hiding this comment.
I think we should at least do something like:
// ... $profiler is the 'profiler' service
$profile = $profiler->loadProfileFromResponse($response);
|
Great job @javiereguiluz! This really shows that rewritting the docs and removing things can bring the docs to a higher level. I think we should add a table listing all priorities used by framework listeners (just move it from the dic_tags reference). This would make it very easy to determine which priority you should use for a custom listener. Btw, there also seems to be a build failure. |
| @@ -110,7 +110,7 @@ Glossary | |||
| The *Kernel* is the core of Symfony. The Kernel object handles HTTP | |||
| requests using all the bundles and libraries registered to it. See | |||
| :ref:`The Architecture: The Application Directory <the-app-dir>` and the | |||
| :doc:`/book/internals` chapter. | |||
| :doc:`Internal Events Reference </reference/events.rst>`. | |||
There was a problem hiding this comment.
You just have to omit the file extension here. :)
javiereguiluz
force-pushed
the
book_remove_internals_chapter
branch
from
4b7e4d3 to
7ee9465
Compare
|
As suggested, I've moved the tables about built-in event listeners from DIC Tags reference to the new Events reference. Do you have any other suggestions or can we consider this PR as finished? Thanks. |
|
You have to remove the reference to the stable API chapter from the |
|
@xabbuh done! |
|
The same also applies to |
|
@xabbuh done! I'm sorry for not doing it right at first :( |
| | `EmailSenderListener`_ | 0 | | ||
| +-------------------------------------------------------------------------------------------+----------+ | ||
| For the reference of Event Listeners associated with each kernel event, see the | ||
| :doc:`Symfony Events Reference reference/events`. |
There was a problem hiding this comment.
Angle brackets and the leading slash for the document are missing.
|
Hi @javiereguiluz. Can you please rebase? |
javiereguiluz
force-pushed
the
book_remove_internals_chapter
branch
from
352bcba to
417dae6
Compare
|
@wouterj done. Let's see if conflicts are gone now. |
|
👍 |
…viereguiluz) This PR was merged into the 2.3 branch. Discussion ---------- Removed the Internals chapter from the Symfony book | Q | A | ------------- | --- | Doc fix? | no | New docs? | no | Applies to | all | Fixed tickets | - The two main reasons for this change are: 1) the traffic to that book chapter is marginal; 2) all the things explained in this chapter are better explained in other parts of the documentation. This chapter was written before the documentation of the components was available. The only important thing about this chapter is the information about kernel events. I propose to create a new reference document about events. Let's bootstrap that document with this existing info and let's add in the future the rest of Symfony events (security, forms, etc.) Commits ------- 417dae6 Improved a lot of things thanks to the comments made by reviewers 4c5c851 Fixed the link of an internal cross reference 0f6141a Removed reference to Stable API chapter from book map file bf33953 Removed the reference to the deleted Stable API book chapter 8fcda08 Moved the table of event listeners from the DIC tags article to the events reference 8dabfb1 Implemented most of the changes suggested by reviewers 650d82d Fixed another wrong internal cross reference f6432ad Fixed some wrong cross references fb4a63f Updated the references to the Symfony Profiler documentation 81e4cfe Added a redirection to avoid 404 errors fc85752 Created a new cookbook about getting profiler data programmatically 67831b3 Removed the Internals chapter from the Symfony book
|
Great! Merged with some minor updates at #5297. Thanks Javier! |
This PR was merged into the 2.3 branch. Discussion ---------- Kernel Events Proofreading after #4901 | Q | A | ------------- | --- | Doc fix? | yes | New docs? | no | Applies to | 2.3+ | Fixed tickets | n/a Hi guys! This is a proofread of #4901. I removed the ticks in the titles - iirc, the ticks don't work in titles. I also fixed a few minor bugs I believe. Thanks! Commits ------- c7326da another fix! 106bda9 re-adding literals cd820d7 Proofreading after #4901
The two main reasons for this change are: 1) the traffic to that book chapter is marginal; 2) all the things explained in this chapter are better explained in other parts of the documentation. This chapter was written before the documentation of the components was available.
The only important thing about this chapter is the information about kernel events. I propose to create a new reference document about events. Let's bootstrap that document with this existing info and let's add in the future the rest of Symfony events (security, forms, etc.)