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

Add initial docs for the DataViews component #55435

Merged
merged 1 commit into from
Oct 18, 2023
Merged

Conversation

oandregal
Copy link
Member

@oandregal oandregal commented Oct 18, 2023

Part of #55083

What?

Add initial docs for the DataViews component and the related APIs: view, fields.

Why?

To communicate and clarify the terminology and APIs in place.

Test

Read document.

@oandregal oandregal self-assigned this Oct 18, 2023
@oandregal oandregal added [Type] Developer Documentation Documentation for developers [Feature] DataViews Work surrounding upgrading and evolving views in the site editor and beyond labels Oct 18, 2023

The view is responsible for configuring how the dataset is visible to the user. For example:

```js
Copy link
Contributor

Choose a reason for hiding this comment

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

Do you think we should also add the type definitions for the interfaces used in the main component or somewhere, now?

Copy link
Member Author

Choose a reason for hiding this comment

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

At some point, it'd be good to have them, sure.

Right now, my main concern is to have a high-level map of the code, so to speak. I'd like to give people a little orientation about how to navigate the hundreds of lines of code. Writing things down is how I think, so I am biased towards believing this may be helpful to some others as well.

@github-actions
Copy link

Flaky tests detected in b319ef4.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/6558238685
📝 Reported issues:

@oandregal oandregal merged commit c5c8c16 into trunk Oct 18, 2023
54 of 56 checks passed
@oandregal oandregal deleted the add/docs-for-dataview branch October 18, 2023 09:23
@github-actions github-actions bot added this to the Gutenberg 16.9 milestone Oct 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] DataViews Work surrounding upgrading and evolving views in the site editor and beyond [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants