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

Document known changes in editor behavior #4186

Closed
5 tasks
danielbachhuber opened this issue Dec 27, 2017 · 6 comments
Closed
5 tasks

Document known changes in editor behavior #4186

danielbachhuber opened this issue Dec 27, 2017 · 6 comments
Assignees
Labels
Backwards Compatibility Issues or PRs that impact backwards compatability [Type] Developer Documentation Documentation for developers

Comments

@danielbachhuber
Copy link
Member

danielbachhuber commented Dec 27, 2017

As a user switching from the Classic to Gutenberg editor, it would be helpful to have a documented list of UX changes so I can know which changes are intentional vs. which might be bugs. My expectation, as a user switching from one to the other, is that they're as consistent as possible.

A non-exhaustive list of changes includes:

Previously #4181

Related:

@youknowriad
Copy link
Contributor

My expectation, as a user switching from one to the other, is that they're as consistent as possible.

While I'm not sure I agree with this statement as we're trying to improve the editor so being consistent is not a goal in itself but yeah we should educate users and NUX #3670 #4173 is part of the solution here.

@danielbachhuber
Copy link
Member Author

While I'm not sure I agree with this statement as we're trying to improve the editor so being consistent is not a goal in itself

Maybe a better way of phrasing is:

Any editor UX changes are deliberate and documented. Those that aren't can be considered bugs.

The default should be consistent behavior between editors, except where a deliberate decision has been made to change the behavior.

@Soean Soean added the [Type] Developer Documentation Documentation for developers label Dec 29, 2017
@danielbachhuber danielbachhuber added this to the Merge Proposal milestone Apr 10, 2018
@karmatosed karmatosed modified the milestones: Merge Proposal: Editor, Merge Proposal: Documentation Apr 12, 2018
@danielbachhuber danielbachhuber self-assigned this Jun 27, 2018
@danielbachhuber danielbachhuber added the Backwards Compatibility Issues or PRs that impact backwards compatability label Jun 27, 2018
@danielbachhuber danielbachhuber removed their assignment Oct 7, 2018
@danielbachhuber
Copy link
Member Author

@chrisvanpatten volunteered to help get this over the finish line. We can use https://github.com/danielbachhuber/gutenberg-migration-guide as a starting point for these details.

This was referenced Nov 6, 2018
@designsimply
Copy link
Member

@danielbachhuber what action is still needed for this issue. Since 11252 and 11251 each mention documentation sections such as "What's different about the new editor?" and "Important deprecations/changes from 4.x" respectively, can we close this issue in favor of finalizing work in the new issues?

@danielbachhuber
Copy link
Member Author

Since 11252 and 11251 each mention documentation sections such as "What's different about the new editor?" and "Important deprecations/changes from 4.x" respectively, can we close this issue in favor of finalizing work in the new issues?

Sure, that's fine. It seems like moving chairs around though.

@designsimply
Copy link
Member

Cool. It looked to me like several things had already been addressed in closed PRs and I am working to consolidate issues where possible. Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backwards Compatibility Issues or PRs that impact backwards compatability [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

No branches or pull requests

6 participants