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

Documentation linking to 3rd-party articles #4871

Closed
ifdattic opened this issue Jan 17, 2015 · 3 comments
Closed

Documentation linking to 3rd-party articles #4871

ifdattic opened this issue Jan 17, 2015 · 3 comments

Comments

@ifdattic
Copy link
Contributor

At SymfonyCon Madrid @weaverryan during one of discussions proposed the idea of having a section for linking to 3rd-party resources. While reading the http://symfony.com/doc/current/cookbook/configuration/pdo_session_storage.html I remembered that idea and (shameless plug) as having written a similar article http://ifdattic.com/how-to-mongodb-sessions-symfony-application I asked Ryan about his thoughts on this one.

We think it would be best to get a lot of feedback from the community to decide on this "external linking" test case.

A. If we want to allow external links
B. What the requirements would be
C. Where these should live

@javiereguiluz
Copy link
Member

@ifdattic I appreciate that you suggested this idea to improve documentation, but I propose to close it as won't fix.

I agree that the official Symfony doc cannot cover everything. I also agree that there are some fantastic third-party resources and articles. However, linking to external websites is always a risk for the official documentation of a big project. What if the linked article goes down or changes its URL? Someone should check the third-party URLs regularly. What if the third-party site includes inappropriate ads? Someone should again check that regularly. What if the external article is no longer relevant because its contents are deprecated? Again, someone should check that continuously.

In any case, I agree that the Symfony ecosystem is very important and we should give more credit to them. That's why I proposed to mention and link to more popular third-party bundles in the Symfony documentation. See #5373

Let's see if @wouterj and @xabbuh agree with my comments.

@ifdattic
Copy link
Contributor Author

@javiereguiluz It's fine. I agree that this might add a lot of maintenance and in time become more of a bother than good.

@harikt
Copy link
Contributor

harikt commented Jun 16, 2015

I am +1 for @javiereguiluz comment. His words are absolutely true.

Also as symfony blog itself covers they talked about us may be a place for it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants