devdocs icon indicating copy to clipboard operation
devdocs copied to clipboard

Consider consolidating backcompat docs

Open DrewML opened this issue 5 years ago • 5 comments

Topic clarification/correction request

Topic Link

https://github.com/magento/devdocs/blob/master/src/guides/v2.4/contributor-guide/backward-compatible-development/index.md

https://github.com/magento/devdocs/blob/master/src/guides/v2.4/extension-dev-guide/versioning/codebase-changes.md

Description

As far as I can tell, these documents overlap quite a bit, and it's not quite clear what the source of truth is.

Possible solutions

Create a single document that is the source of truth for all backwards-compatible and backwards-incompatible change types.

DrewML avatar Sep 24 '19 23:09 DrewML

cc @jcalcaben (don't have perms to assign you)

DrewML avatar Sep 24 '19 23:09 DrewML

Clearing the assignee because there has been no action on this since September 2019.

shrielenee avatar Sep 03 '20 19:09 shrielenee

@shrielenee - I've taken a look at these two pages and whilst they have similarities I don't feel they are close enough to even attempt to merge them into a single document. Plus they are approaching them from different points of view. One document is for contributors to make code changes to the Magento core itself and the other is for extension developers to take into consideration. In my opinion the documentation needs to stay separate. If you concur, can we close this issue?

BarnyShergold avatar Sep 21 '20 10:09 BarnyShergold

This issue cannot be closed @BarnyShergold. It was created by a Magento employee, is still relevant, and while the suggested approach may not be the right one, there is a way we can resolve the raised issue.

If you are not working the actual issue, you must remove yourself as the assignee so someone else can pick it up. I'll remove you for now. Thanks!

shrielenee avatar Sep 21 '20 13:09 shrielenee

That's odd I don't remember assigning myself this!

BarnyShergold avatar Sep 21 '20 13:09 BarnyShergold