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 diverges between this repo and Symfony.com #1605

Open
mpdude opened this issue Jan 3, 2023 · 4 comments
Open

Documentation diverges between this repo and Symfony.com #1605

mpdude opened this issue Jan 3, 2023 · 4 comments

Comments

@mpdude
Copy link
Contributor

mpdude commented Jan 3, 2023

The README points to https://symfony.com/doc/current/reference/configuration/doctrine.html for documentation, claiming that this information would be drawn from Resources/docs. This is not true.

Resources/docs ends up at https://www.doctrine-project.org/projects/doctrine-bundle.html, whereas Symfony documentation comes from https://github.com/symfony/symfony-docs/blob/master/reference/configuration/doctrine.rst (and a few more recommendations/mentions in other places of that repo).

In particular, the "configuration reference" seems to have diverged at some point, with some interesting details and tidbits being available only in either of the two.

How could we resolve that?

I see value in having the documentation here, close to the authoritative source code.

On the other hand, there seems to be much more activity and awareness in https://github.com/symfony/symfony-docs, and symfony.com seems to be what search engines prefer and return for almost all Symfony + Doctrine related searches.

@greg0ire
Copy link
Member

greg0ire commented Jan 3, 2023

Also, the link in the sidebar appears to be dead: https://symfony.com/bundles (links to https://symfony.com/bundles/DoctrineBundle/current/index.html)

@greg0ire
Copy link
Member

greg0ire commented Jan 3, 2023

@mpdude I think https://symfony.com/bundles/DoctrineBundle/2.7.x/configuration.html should be enough, https://symfony.com/doc/current/reference/configuration/doctrine.html should redirect to that, maybe (after merging what's interesting)?

@ostrolucky
Copy link
Member

Should this be fixed by #1606, or what else should be done here?

@greg0ire
Copy link
Member

greg0ire commented Jan 6, 2023

https://github.com/symfony/symfony-docs/blob/6.2/reference/configuration/doctrine.rst good bits should be copy/pasted to https://github.com/doctrine/DoctrineBundle/blob/2.8.x/Resources/doc/configuration.rst by a kind soul, after what the former can be removed (or replaced with a link to the latter) I think.

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

No branches or pull requests

3 participants