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

Extract data format and flow docs into their own architecture document. #25299

Merged
merged 2 commits into from
Sep 18, 2020

Conversation

youknowriad
Copy link
Contributor

There's a couple things here:

  • Extracts and details the data format and flow into its own document archiecture.
  • Moves the "Architecture" docs out of the "Project overview", IMO it doesn't make sense there because the target is very different. That said the "key concepts" document that was present in "Project overview" belongs more in the "Architecture" section.
  • Makes the root "readme.md" as the parent page of the "Project overview" section, the "principles" document that were used previously there was useless IMO.

Note

There's a few other things I want to do separately as well:

  • designers documentation are duplicated and spread across two different sections (its own section and inside the contributions section)
  • flatten the contributor guide
  • Put all the "* Reference" docs in the same section (inside dev docs or in its own section)

@youknowriad youknowriad added the [Type] Developer Documentation Documentation for developers label Sep 14, 2020
@youknowriad youknowriad self-assigned this Sep 14, 2020
@youknowriad youknowriad requested a review from mcsf September 14, 2020 14:46
@github-actions
Copy link

Size Change: 0 B

Total Size: 1.2 MB

ℹ️ View Unchanged
Filename Size Change
build/a11y/index.js 1.14 kB 0 B
build/annotations/index.js 3.67 kB 0 B
build/api-fetch/index.js 3.41 kB 0 B
build/autop/index.js 2.82 kB 0 B
build/blob/index.js 620 B 0 B
build/block-directory/index.js 8.52 kB 0 B
build/block-directory/style-rtl.css 943 B 0 B
build/block-directory/style.css 942 B 0 B
build/block-editor/index.js 128 kB 0 B
build/block-editor/style-rtl.css 11 kB 0 B
build/block-editor/style.css 11 kB 0 B
build/block-library/editor-rtl.css 8.67 kB 0 B
build/block-library/editor.css 8.67 kB 0 B
build/block-library/index.js 139 kB 0 B
build/block-library/style-rtl.css 7.59 kB 0 B
build/block-library/style.css 7.59 kB 0 B
build/block-library/theme-rtl.css 741 B 0 B
build/block-library/theme.css 741 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/blocks/index.js 47.8 kB 0 B
build/components/index.js 202 kB 0 B
build/components/style-rtl.css 15.5 kB 0 B
build/components/style.css 15.4 kB 0 B
build/compose/index.js 9.67 kB 0 B
build/core-data/index.js 12.2 kB 0 B
build/data-controls/index.js 1.29 kB 0 B
build/data/index.js 8.55 kB 0 B
build/date/index.js 31.9 kB 0 B
build/deprecated/index.js 772 B 0 B
build/dom-ready/index.js 568 B 0 B
build/dom/index.js 4.48 kB 0 B
build/edit-navigation/index.js 10.7 kB 0 B
build/edit-navigation/style-rtl.css 868 B 0 B
build/edit-navigation/style.css 871 B 0 B
build/edit-post/index.js 305 kB 0 B
build/edit-post/style-rtl.css 6.24 kB 0 B
build/edit-post/style.css 6.22 kB 0 B
build/edit-site/index.js 19.3 kB 0 B
build/edit-site/style-rtl.css 3.13 kB 0 B
build/edit-site/style.css 3.13 kB 0 B
build/edit-widgets/index.js 12.2 kB 0 B
build/edit-widgets/style-rtl.css 2.55 kB 0 B
build/edit-widgets/style.css 2.55 kB 0 B
build/editor/editor-styles-rtl.css 492 B 0 B
build/editor/editor-styles.css 493 B 0 B
build/editor/index.js 45.3 kB 0 B
build/editor/style-rtl.css 3.8 kB 0 B
build/editor/style.css 3.8 kB 0 B
build/element/index.js 4.65 kB 0 B
build/escape-html/index.js 733 B 0 B
build/format-library/index.js 7.71 kB 0 B
build/format-library/style-rtl.css 547 B 0 B
build/format-library/style.css 548 B 0 B
build/hooks/index.js 2.13 kB 0 B
build/html-entities/index.js 621 B 0 B
build/i18n/index.js 3.56 kB 0 B
build/is-shallow-equal/index.js 711 B 0 B
build/keyboard-shortcuts/index.js 2.52 kB 0 B
build/keycodes/index.js 1.94 kB 0 B
build/list-reusable-blocks/index.js 3.12 kB 0 B
build/list-reusable-blocks/style-rtl.css 476 B 0 B
build/list-reusable-blocks/style.css 476 B 0 B
build/media-utils/index.js 5.31 kB 0 B
build/notices/index.js 1.79 kB 0 B
build/nux/index.js 3.4 kB 0 B
build/nux/style-rtl.css 671 B 0 B
build/nux/style.css 668 B 0 B
build/plugins/index.js 2.56 kB 0 B
build/primitives/index.js 1.41 kB 0 B
build/priority-queue/index.js 789 B 0 B
build/redux-routine/index.js 2.85 kB 0 B
build/rich-text/index.js 13.9 kB 0 B
build/server-side-render/index.js 2.77 kB 0 B
build/shortcode/index.js 1.69 kB 0 B
build/token-list/index.js 1.27 kB 0 B
build/url/index.js 4.06 kB 0 B
build/viewport/index.js 1.85 kB 0 B
build/warning/index.js 1.14 kB 0 B
build/wordcount/index.js 1.17 kB 0 B

compressed-size-action

Copy link
Member

@mkaz mkaz left a comment

Choose a reason for hiding this comment

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

This looks good, the one concern I have is the main page as the Project Overview, hopefully it will not increase the number of items at the top level but just a single item with the other parts nested. It hasn't always done what I expected. :-) So we can see after publishing and adjust as necessary.

I completely agree with the design docs, I've been trying to setup the Contributor's section as the area to go if you want to contribute to the project. So it makes sense there for discussing design aspects of the platform.

The design/develop bifurcation from the start is unfortunate, live and learn, but ideally the split is extending the platform (plugins/themes) and contributing to the platform (project itself).

There is always going to be a fair amount of overlap since the platform is built on itself, most obvious example is the block library, but numerous others with components.

@youknowriad youknowriad merged commit bad9989 into master Sep 18, 2020
@youknowriad youknowriad deleted the update/data-flow-docs branch September 18, 2020 07:09
@github-actions github-actions bot added this to the Gutenberg 9.1 milestone Sep 18, 2020
@youknowriad
Copy link
Contributor Author

Looks like we have two issues: https://developer.wordpress.org/block-editor/

  • I think the frontpage is not updated properly (the title of the page is incorrect)
  • The old "Project Overview" page hasn't been deleted from the site and menu.

@mkaz
Copy link
Member

mkaz commented Sep 18, 2020

@youknowriad As mentioned in Slack, I removed the extra Project Overview page, and renamed the top level document.

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