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 about Yaml, mention it as discouraged to use? #7321

Closed
linaori opened this issue Jul 23, 2018 · 7 comments
Closed

Documentation about Yaml, mention it as discouraged to use? #7321

linaori opened this issue Jul 23, 2018 · 7 comments
Assignees
Milestone

Comments

@linaori
Copy link

linaori commented Jul 23, 2018

Q A
BC Break no
Version 2.6

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
Copy link
Member

@doctrine/team-documentation can we do something about this one?

@SenseException
Copy link
Member

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
Copy link
Contributor

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
Copy link
Author

linaori commented 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
Copy link
Member

@iltar I've created PR #7374. Does it cover this issue?

@linaori
Copy link
Author

linaori commented Sep 6, 2018

Looks good to me!

@Majkl578
Copy link
Contributor

@Majkl578 Majkl578 modified the milestones: 2.7.0, 2.6.3 Nov 11, 2018
@Majkl578 Majkl578 self-assigned this Nov 11, 2018
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

5 participants