Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Suggestion] Move the SwiftmailerBundle and MonologBundle docs to the bundle repos #4983

Closed
stof opened this issue Feb 10, 2015 · 8 comments
Closed
Labels
actionable Clear and specific issues ready for anyone to take them.

Comments

@stof
Copy link
Member

stof commented Feb 10, 2015

Given that these bundles are versionned independently of Symfony, having their doc in the symfony-docs repo makes it hard to handle version changes (new features in these bundles can be used in any version of Symfony as soon as you update the bundle, because they both support Symfony 2.3+ in their latest version).
The doc for these bundles should then of course be rendered on symfony.com

What do you think @wouterj @weaverryan @xabbuh ?

@wouterj
Copy link
Member

wouterj commented Feb 10, 2015

👍

@xabbuh
Copy link
Member

xabbuh commented Feb 10, 2015

👍 Sounds like a reasonable change to me (we already have the same for other bundles that are closely related to Symfony).

@weaverryan
Copy link
Member

I wrote a big note that I was -1 on this, then changed it. My biggest issues is that these other repositories have less attention on them, so I'm afraid the docs would suffer because of that.

@wouterj
Copy link
Member

wouterj commented Mar 15, 2015

@weaverryan looking at the activity for the monolog doc sections, I don't think it recieves much attention here too

@weaverryan weaverryan added the actionable Clear and specific issues ready for anyone to take them. label Mar 22, 2015
@weaverryan
Copy link
Member

Ok, 👍 from me - let's try it. Steps:

  1. Get something bootstrapped for the docs for each
  2. Get them rendered on the site
  3. Move the docs over to the bundle and replace the existing entries with external links.

We still need to make the docs feel integrated - so I'd still want them to show up in the cookbook, for example, it would just take you into their docs.

@wouterj
Copy link
Member

wouterj commented May 9, 2015

MonologBundle

SwiftmailerBundle

@xabbuh
Copy link
Member

xabbuh commented May 23, 2015

@snoek09 started this for the SwiftmailerBundle in symfony/swiftmailer-bundle#102.

fabpot added a commit to symfony/swiftmailer-bundle that referenced this issue May 23, 2015
This PR was squashed before being merged into the 2.3-dev branch (closes #102).

Discussion
----------

[WIP] moving SwiftmailerBundle docs to bundle repo

Added installation chapter.

Easy picks on bundle side from symfony/symfony-docs#4983

Commits
-------

ff2ffda [WIP] moving SwiftmailerBundle docs to bundle repo
@javiereguiluz
Copy link
Member

Closing this old issue as done. We've already moved some doc to those external repos, but we can't move the essential docs about logging and mailer out of the main Symfony Docs. So we've finished here. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
actionable Clear and specific issues ready for anyone to take them.
Projects
None yet
Development

No branches or pull requests

5 participants