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

Docs: Document block validation, clarify extensibility validation #4782

Merged
merged 4 commits into from
Feb 5, 2018

Conversation

aduth
Copy link
Member

@aduth aduth commented Jan 31, 2018

Closes #4759

This pull request seeks to add documentation for block validation, describing the process for determining whether a block is invalid, options presented to the user for resolving the invalidation, and debugging steps for plugin authors. Further, it clarifies a confusion about block extensibility and its relation to validation.

Testing instructions:

There are no behavior impact expected with the changes proposed here.

@aduth aduth added the [Type] Developer Documentation Documentation for developers label Jan 31, 2018
@youknowriad
Copy link
Contributor

Validation is also tied to the deprecated blocks API which is documented on a separate page right now. I wonder how we could better organize all these related docs.

@aduth
Copy link
Member Author

aduth commented Feb 5, 2018

Validation is also tied to the deprecated blocks API which is documented on a separate page right now. I wonder how we could better organize all these related docs.

Maybe it'd be enough to add a question to the FAQ section here about "intended invalidations" ?

I changed my block's save behavior and now old content includes invalid blocks. How can I fix this?

Refer to the guide on Deprecated Blocks to learn more about how to accommodate legacy content in intentional markup changes.

@youknowriad
Copy link
Contributor

Maybe it'd be enough to add a question to the FAQ section here about "intended invalidations" ?

@aduth I like this proposal 👍

@aduth
Copy link
Member Author

aduth commented Feb 5, 2018

Updated in 94902d9

@aduth aduth merged commit f325876 into master Feb 5, 2018
@aduth aduth deleted the fix/4759-docs-example-filter branch February 5, 2018 20:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants