Skip to content

Extract Block Transforms into its own handbook page#21734

Merged
oandregal merged 27 commits into
masterfrom
add/block-transforms-docs
Apr 23, 2020
Merged

Extract Block Transforms into its own handbook page#21734
oandregal merged 27 commits into
masterfrom
add/block-transforms-docs

Conversation

@oandregal

@oandregal oandregal commented Apr 20, 2020 •
edited
Loading

Copy link
Copy Markdown
Member

Part of #20161

This PR extracts and extends the existing Block Transforms API docs into a sub-section of "Block API Reference".

  • Adds and/or normalizes contents for every type of transformation currently available: block, enter, files, prefix, raw, shortcode.
  • Refactors the existing transforms section within the block registration to point to the new page.
  • Adds a new page to the handbook.

Compare: new content, old content.

@oandregal oandregal self-assigned this Apr 20, 2020
@oandregal oandregal requested a review from talldan April 20, 2020 16:57
@oandregal oandregal added the [Type] Developer Documentation Documentation for developers label Apr 20, 2020
@oandregal oandregal changed the title Add skeleton for new Block Transforms section Extract Block Transforms into its own handbook page Apr 20, 2020
@github-actions

github-actions Bot commented Apr 20, 2020 •
edited
Loading

Copy link
Copy Markdown

Size Change: +3.06 kB (0%)

Total Size: 845 kB

Filename Size Change
build/annotations/index.js 3.62 kB +2 B (0%)
build/api-fetch/index.js 4.08 kB +72 B (1%)
build/block-directory/index.js 6.24 kB -1 B
build/block-editor/index.js 105 kB +18 B (0%)
build/block-editor/style-rtl.css 10.1 kB -21 B (0%)
build/block-editor/style.css 10.1 kB -22 B (0%)
build/block-library/editor-rtl.css 7.13 kB +33 B (0%)
build/block-library/editor.css 7.13 kB +30 B (0%)
build/block-library/index.js 112 kB +391 B (0%)
build/block-library/style-rtl.css 7.19 kB +20 B (0%)
build/block-library/style.css 7.19 kB +19 B (0%)
build/blocks/index.js 57.7 kB -1 B
build/components/index.js 198 kB +8 B (0%)
build/data-controls/index.js 1.25 kB +1 B
build/edit-post/index.js 28.2 kB +253 B (0%)
build/edit-post/style-rtl.css 12.5 kB +195 B (1%)
build/edit-post/style.css 12.5 kB +196 B (1%)
build/edit-site/index.js 10.8 kB +334 B (3%)
build/edit-site/style-rtl.css 5.25 kB +207 B (3%)
build/edit-site/style.css 5.24 kB +209 B (3%)
build/edit-widgets/index.js 8.33 kB +843 B (10%) ⚠️
build/edit-widgets/style-rtl.css 5 kB +344 B (6%) 🔍
build/edit-widgets/style.css 5 kB +347 B (6%) 🔍
build/editor/index.js 43.3 kB -1 B
build/editor/style-rtl.css 3.27 kB -208 B (6%) ✅
build/editor/style.css 3.27 kB -208 B (6%) ✅
build/element/index.js 4.65 kB +3 B (0%)
build/format-library/index.js 7.32 kB +2 B (0%)
build/keyboard-shortcuts/index.js 2.51 kB -1 B
build/list-reusable-blocks/index.js 3.12 kB -1 B
build/media-utils/index.js 5.29 kB -1 B
build/nux/index.js 3.4 kB +1 B
build/primitives/index.js 1.49 kB +1 B
build/rich-text/index.js 14.8 kB -2 B (0%)
build/server-side-render/index.js 2.67 kB +2 B (0%)
ℹ️ View Unchanged
Filename Size Change
build/a11y/index.js 1.02 kB 0 B
build/autop/index.js 2.82 kB 0 B
build/blob/index.js 620 B 0 B
build/block-directory/style-rtl.css 760 B 0 B
build/block-directory/style.css 761 B 0 B
build/block-library/theme-rtl.css 683 B 0 B
build/block-library/theme.css 685 B 0 B
build/block-serialization-default-parser/index.js 1.88 kB 0 B
build/block-serialization-spec-parser/index.js 3.1 kB 0 B
build/components/style-rtl.css 16.9 kB 0 B
build/components/style.css 16.9 kB 0 B
build/compose/index.js 6.66 kB 0 B
build/core-data/index.js 11.4 kB 0 B
build/data/index.js 8.43 kB 0 B
build/date/index.js 5.47 kB 0 B
build/deprecated/index.js 772 B 0 B
build/dom-ready/index.js 569 B 0 B
build/dom/index.js 3.1 kB 0 B
build/edit-navigation/index.js 3.54 kB 0 B
build/edit-navigation/style-rtl.css 485 B 0 B
build/edit-navigation/style.css 485 B 0 B
build/editor/editor-styles-rtl.css 428 B 0 B
build/editor/editor-styles.css 431 B 0 B
build/escape-html/index.js 733 B 0 B
build/format-library/style-rtl.css 502 B 0 B
build/format-library/style.css 502 B 0 B
build/hooks/index.js 2.13 kB 0 B
build/html-entities/index.js 622 B 0 B
build/i18n/index.js 3.56 kB 0 B
build/is-shallow-equal/index.js 711 B 0 B
build/keycodes/index.js 1.94 kB 0 B
build/list-reusable-blocks/style-rtl.css 226 B 0 B
build/list-reusable-blocks/style.css 226 B 0 B
build/notices/index.js 1.79 kB 0 B
build/nux/style-rtl.css 616 B 0 B
build/nux/style.css 613 B 0 B
build/plugins/index.js 2.67 kB 0 B
build/priority-queue/index.js 789 B 0 B
build/redux-routine/index.js 2.84 kB 0 B
build/shortcode/index.js 1.7 kB 0 B
build/token-list/index.js 1.28 kB 0 B
build/url/index.js 4.02 kB 0 B
build/viewport/index.js 1.84 kB 0 B
build/warning/index.js 1.14 kB 0 B
build/wordcount/index.js 1.17 kB 0 B

compressed-size-action

@oandregal oandregal added the [Status] In Progress Tracking issues with work in progress label Apr 21, 2020
@oandregal oandregal requested a review from ellatrix April 23, 2020 06:49
@oandregal oandregal requested a review from mcsf April 23, 2020 11:09
@oandregal oandregal removed the [Status] In Progress Tracking issues with work in progress label Apr 23, 2020
@oandregal oandregal marked this pull request as ready for review April 23, 2020 12:23
ellatrix
ellatrix reviewed Apr 23, 2020
View reviewed changes
Comment thread docs/designers-developers/developers/block-api/block-transforms.md Outdated
mkaz
mkaz approved these changes Apr 23, 2020
View reviewed changes

@mkaz mkaz left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Good stuff Andres. Thanks for contributing and helping keep the docs organized.

We may want to cherry-pick to branch if possible to update Block Editor handbook which is pinned to wp/5.4 branch. Though it might potentially be tricky depending on other doc changes.

What we really need is multiple versions of docs published and be able to toggle between branches.

@oandregal oandregal merged commit aa44b76 into master Apr 23, 2020
@oandregal oandregal deleted the add/block-transforms-docs branch April 23, 2020 16:27
@github-actions github-actions Bot added this to the Gutenberg 8.0 milestone Apr 23, 2020
@oandregal oandregal mentioned this pull request Apr 23, 2020
Closed
4 tasks
@oandregal

oandregal commented Apr 24, 2020

Copy link
Copy Markdown
Member Author

@mkaz In doing some archeology I found the old ticket for sub-components README!

@oandregal oandregal mentioned this pull request Apr 24, 2020
Closed
@oandregal

oandregal commented Apr 24, 2020

Copy link
Copy Markdown
Member Author

Follow-up about how to update handbook's contents.

@oandregal oandregal mentioned this pull request Apr 24, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mkaz mkaz mkaz approved these changes
@ellatrix ellatrix ellatrix approved these changes
@talldan talldan Awaiting requested review from talldan
@mcsf mcsf Awaiting requested review from mcsf
@ajitbohra ajitbohra Awaiting requested review from ajitbohra
@chrisvanpatten chrisvanpatten Awaiting requested review from chrisvanpatten
@youknowriad youknowriad Awaiting requested review from youknowriad

Assignees

@oandregal oandregal

Labels

[Feature] Paste [Type] Developer Documentation Documentation for developers

Projects

None yet

Milestone

Gutenberg 8.0

Development

Successfully merging this pull request may close these issues.

3 participants

@oandregal @mkaz @ellatrix