Add integrations, add symfony bundle documentation #93
Conversation
|
Here is a suggestion to structure/headings:
Pages:
Is this structure okey? Any other suggestions or comments? |
|
Looks good to me. Although for me installation sounds more logical before configuration. |
|
I've thought about this a lot and I believe we discussed that in the Sound of Symfony podcast. My reasoning is the following: To be honest, I do not think many people will read our 4 lines of introduction before they look at the usage example. But that is my 50cent |
|
Actually that sounds quite reasonable. In this case I guess configuration is some kind of minimalistic example of configuration. |
|
Yes, Do you mind if I make a PR to this branch? |
|
Not at all, but you are free to push to this branch directly. |
|
in the symfony cmf, we have things in chronological order, so installation first, then configuration. and first have a short introduction that explains what the bundle does, without code. as installation is quite short, it should not be difficult to scroll over it when looking for how the bundle works. i would vote for keeping the technical order here - but if you all think the other way round is better, i won't make a fuss :-) |
|
|
||
| The usage documentation is split into two parts. First we explain how to configure the bundle in an application. The second part is for developing reusable Symfony bundles that depend on an HTTP client defined by the Httplug interface. | ||
|
|
||
| For information how to write applications with the services provided by this bundle, have a look at the [Httplug documentation](http://docs.php-http.org). |
There was a problem hiding this comment.
this is now the same documentation, so we should probably do this as internal link and rephrase.
|
most of my comments are already handled in #94, only a few remaining:
|
|
once we have #96 in this, i am happy with this to be merged. |
|
How about #95? |
|
ups, sorry. merge that one. i am fixing the spelling errors in #96 (i hope all of them...) |
|
we also need to update the application-developers.rst |
| @@ -1,11 +0,0 @@ | |||
| HTTPlug for application developers | |||
There was a problem hiding this comment.
this was only linking to the httplug bundle so it becomes redundant with the integrations chapter.
|
LGTM Squash first? |
dbu
force-pushed
the
symfony_bundle
branch
2 times, most recently
from
b487394 to
da1a879
Compare
|
squashed all commits. sorry tobias, authorship is now shown as mark... but things where moved around a lot, so i thought keeping several commits is unnecessary confusing. |
sagikazarmark
force-pushed
the
symfony_bundle
branch
from
da1a879 to
c14dfd7
Compare
|
MUHAHAHAHAHAHAHA |
|
|
|
Just for the record that I was the author earlier. Now Tobias is. 😉 |
|
Yeah, that is weird. I though I would disappear from the history when squashed... |
Add integrations, add symfony bundle documentation
Initial version based on README. Needs proofreading.