mirror of
https://github.com/doctrine/orm.git
synced 2026-03-23 22:42:18 +01:00
Documentation about Yaml, mention it as discouraged to use? #6027
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @linaori on GitHub (Jul 23, 2018).
Originally assigned to: @Majkl578 on GitHub.
Summary
The documentation page about Yaml does not mention anything about it being removed/unsupported in the future. I think it's a good idea to mention on here that it's discouraged to use Yaml as configuration.
Whenever I see people suggest to not use Yaml because it's going to be removed as core supported configuration, the response is usually "oh I did not know that".
@Ocramius commented on GitHub (Aug 23, 2018):
@doctrine/team-documentation can we do something about this one?
@SenseException commented on GitHub (Aug 23, 2018):
This should get a highlighted box at the beginning of the page mentioning its deprecation and removal.
I guess this part of the ORM documentation can be removed for the right ORM version.
@weaverryan commented on GitHub (Aug 23, 2018):
I would be +1 for removing it on the latest minor version docs. Basically, because it is now deprecated, why show it at all? Older versions of the docs will still exist for existing users to reference. We can cleanup the new version right now.
@linaori commented on GitHub (Aug 23, 2018):
It's already known to be deprecated and 2.6 is the current documentation. If a developer takes a look at the documentation, and doesn't see a deprecation, chances are that everything is going to be created in Yaml. This is a waste of time for the developer because it's already known to disappear with 3.0. Not letting the developer know this as soon as possible, will thus result in extra work while it was not necessary.
@SenseException commented on GitHub (Sep 6, 2018):
@iltar I've created PR #7374. Does it cover this issue?
@linaori commented on GitHub (Sep 6, 2018):
Looks good to me!
@Majkl578 commented on GitHub (Nov 11, 2018):
#7374 has been merged into 2.6.
https://www.doctrine-project.org/projects/doctrine-orm/en/2.6/reference/yaml-mapping.html#yaml-mapping