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

Add a statement to docs regarding backwards compatibility #4738

Open
danielbachhuber opened this Issue Jan 29, 2018 · 6 comments

Comments

Projects
None yet
5 participants
@danielbachhuber
Member

danielbachhuber commented Jan 29, 2018

For those working on Gutenberg's adoption in the broader WordPress ecosystem, it would be helpful to add a statement to the docs regarding backwards compatibility.

Specifically:

  • Where does Gutenberg try to maintain backwards compatibility?
  • What's the decision-making process around maintaining backwards compatibility vs. not?
  • Where has backwards compatibility deliberately been broken?

Once we have this statement in place, it'll be more straightforward to address the existing backwards compat issues.

Related #4151 #4186 #4190

@bobbingwide

This comment has been minimized.

Contributor

bobbingwide commented Jan 29, 2018

Note that the backwards compatibility label may not be have been applied to all issues which are affected. Some are just labelled bug.

@danielbachhuber

This comment has been minimized.

Member

danielbachhuber commented Jan 29, 2018

Note that the backwards compatibility label may not be have been applied to all issues which are affected. Some are just labelled bug.

Correct. I've been adding them as I've come across them.

@bobbingwide

This comment has been minimized.

Contributor

bobbingwide commented Jan 29, 2018

Can you add #4456 please.

@wsydney76

This comment has been minimized.

wsydney76 commented Jan 29, 2018

There is also #3964 still unanswered.

@danielbachhuber danielbachhuber added this to the Merge Proposal: Back Compat milestone May 25, 2018

@danielbachhuber

This comment has been minimized.

Member

danielbachhuber commented Oct 13, 2018

I attempted to answer the backwards compatibility question to the best of my knowledge: https://danielbachhuber.com/2018/10/13/three-flavors-of-gutenberg-backwards-compatibility/

@chrisvanpatten

This comment has been minimized.

Contributor

chrisvanpatten commented Nov 6, 2018

Per today's documentation bug scrub, the ticket raises three particular questions:

Where does Gutenberg try to maintain backwards compatibility?
What's the decision-making process around maintaining backwards compatibility vs. not?
Where has backwards compatibility deliberately been broken?

I feel like the first and third questions are best answered in #4186, but the 2nd question is unanswered.

Do any of the leads have particular opinions on that second question (how back-compat breaks are decided)? Is it a question even worth answering in documentation? If not, I'd propose we close this ticket and roll the rest into #4186.

cc @mtias @youknowriad @karmatosed etc.

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