Docs: Switch code distinction to JSX & Plain #37348
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gziolo
approved these changes
Dec 17, 2021
There was a problem hiding this comment.
This is awesome. I like how the new strategy allows removing several duplicated examples of the same code written in ESNext and ES5 which are now identical. In fact, as long as we don't deal with React components you don't need to have two versions of the same example anymore which removes a lot of overhead for both the documentation authors and the consumers of the handbook.
Great work wrangling all the changes. I haven't verified very carefully the individual examples because it's too many of them, but I verified all changes to how we present JSX and Plain version of code examples and it looks great from my perspective.
gziolo
added
the
Developer Experience
ryanwelcher
requested changes
Dec 17, 2021
ryanwelcher
approved these changes
Dec 17, 2021
The distinction between JavaScript examples shown in code is not really between the JavaScript syntax, ESNext and ES5, since we dropped IE11 support; but between code that requires a build due to JSX and Plain JavaScript that does not require a build.
The code examples are duplicated with the basic differences being destructuring and function definitions, no JSX code used. With the dropping of IE11 support, the minimum targeted browser supports the ES6 code that is being used, so we don't need both examples.
Thanks Ryan for the additions, they all look good 👍 Co-authored-by: Ryan Welcher <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The distinction between JavaScript examples shown in code is no longer between JavaScript syntaxes, ESNext and ES5, since we dropped IE11 support; but between code that requires a build due to JSX and Plain JavaScript that does not require a build.
Update codetabs changing lables from ESNext & ES5 to JSX & Plain.
Updates various pages and descriptions of what version to show, including documentation guide.
Updates block-transforms docs to remove ES5 code examples. The code examples are duplicated with the basic differences being destructuring and function definitions, no JSX code used. So with the dropping of IE11 support, our minimum targeted browser supports the ES6 code that is being used, so we don't need both examples.
How has this been tested?
Documentation changes, check for:
Note: I did not change the examples code that use
-esnextsuffix, those changes will probably need to be coordinated with the gutenberg-examples repo and make sure any links are also updated.Types of changes
Documentation updates.
Closes #35776