[HttpKernel] Bootstrapping the HttpKernel Component Documentation #2064
Conversation
…using images with permission and courtesy of @fabpot from: https://speakerdeck.com/fabpot/symfony2-meets-drupal-8
| The HttpKernel Component provides a structured process for converting | ||
| a Request into a Response by making use of the event dispatcher. It's | ||
| flexible enough to create a full-stack framework (Symfony), a micro-framework | ||
| (Silex) or an advanced CMS system (Drupal). |
There was a problem hiding this comment.
We do that in all component documents.
|
You should create some interlinking to this aswell, for instance in the introduction paragraphs of the Event Dispatcher Component, we talked about this component and it's event features, we should add a link this this documentation. |
|
Hi guys! Thanks to @Drak, @wouterj and @stof for the really quick check on this - you guys each had some really good suggestions, I've taken all of them into account. Also, after a merge, the following changes will need to be made on the 2.1 branch (which I'll do after a merge):
Thanks! |
|
|
||
| Another common listener is routing. A router listener may process the ``Request`` | ||
| and determine the controller that should be rendered (see the next section). | ||
| In fact, the ``Request`` object has an ":ref:`attributes<component-foundation-attributes>`" |
There was a problem hiding this comment.
Yes, I prefer the backticking of the classes as it makes the code more readable as instantly recognisable as something special. making then ::class:: links initially and then backticks is 👍
|
Looks good to merge now. |
|
@weaverryan - I think you should get this merged and then progress to the 2.1 docs. We can tweak the documents to perfection afterwards. |
[HttpKernel] Bootstrapping the HttpKernel Component Documentation
|
Hi guys! Thanks again very much for your help on this! I've now merged this into 2.0, made the 2.1 changes at sha: 2d23d72 and merged up to 2.1 and master. If anyone sees any issues, please let me know! Again, I'm very excited to have these docs and have so many people driving to get them done and done well. There's certainly more to cover from here, which we should probably start to break out into individual documents in this section. Thanks! |
|
Also, I've just seen the first render of the docs at symfony.com, and we're missing the images right now. Let's wait for a full nightly re-render - I believe I've just missed today's re-render by a few hours. So if it's not better in 24 hours, then we'll check into it further. |
|
ping @fabpot |
|
The images are shown here (maybe a hard refresh works?) |
|
I'm also seeing the images now, so we're good! |
|
Now it is rendered, it looks like a really long page to me. Long scrollbars scaries people, at least me. We can maybe find places to split this into multiple articles? |
|
Yes, and the images should be a little less than the width of the text, they are a bit imposing as it stands. I'd also have a little spacing before and after the image, they are currently a bit too flush to the text in some places. |
|
There is also a rendering issue, see attached: ping @fabpot |
Hiya guys!
Here's the long awaited first pass at the HttpKernel component documentation - thanks to @Drak for poking me on this and @richardmiller for this patience! The images used here are with Fabien's permission from his https://speakerdeck.com/fabpot/symfony2-meets-drupal-8 presentation.
If anyone has a few minutes, please read this over - comment about any corrections or anything that you think will need to be added later or changed. I'd like to merge this relatively quickly so that all of us in the community has the opportunity to improve it from here.
Thanks!