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.

Sign up for GitHub

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

Jump to bottom

Blocks: introduce new way to declare custom descriptions for blocks. #29402

Closed
wants to merge 3 commits into from
Closed

Blocks: introduce new way to declare custom descriptions for blocks. #29402

wants to merge 3 commits into from

Conversation

jeherve
Copy link
Member

@jeherve jeherve commented Mar 9, 2023 •
edited

Fixes #26792

Proposed changess

Warning
This is just a POC. It's not perfect, and has issues as I discussed here: #26792 (comment)
Ideally we should find a better solution.

This PR introduces a new custom description parameter we can pass when registering a Jetpack block. If we pass such a parameter, a new panel is created in the block sidebar to display the custom description.

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

See #26792
See #27795

Does this pull request change what data or activity we track or use?

  • No

Testing instructions:

  • Check out this branch on a site running WP 6.2 Beta.
  • See that the block descriptions for the blocks modified in this PR are still appearing in the sidebar.

@jeherve jeherve self-assigned this Mar 9, 2023
@jeherve jeherve added [Type] Bug When a feature is broken and / or not performing as intended [Status] Proposal [Pri] Normal [Focus] Blocks Issues related to the block editor, aka Gutenberg, and its extensions developed in Jetpack DO NOT MERGE don't merge it! labels Mar 9, 2023
@github-actions github-actions bot added [Block] AI Image [Block] Pay With Paypal aka Simple Payments [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Status] In Progress labels Mar 9, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Mar 9, 2023 •
edited

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ All commits were linted before commit.
  • ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.

Once your PR is ready for review, check one last time that all required checks (other than "Required review") appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team review" label and ask someone from your team review the code.
Once you’ve done so, switch to the "[Status] Needs Review" label; someone from Jetpack Crew will then review this PR and merge it to be included in the next Jetpack release.

Jetpack plugin:

  • Next scheduled release: April 4, 2023.
  • Scheduled code freeze: March 28, 2023.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 9, 2023 •
edited

Are you an Automattician? You can now test your Pull Request on WordPress.com. On your sandbox, run

bin/jetpack-downloader test jetpack update/block-descriptions

to get started. More details: p9dueE-5Nn-p2

jeherve added a commit that referenced this pull request Mar 28, 2023
@jeherve
Blocks: only use strings in block descriptions
201d3d0 
Closes #29402

Discussion: #26792

Until we have a better way to have custom descriptions for blocks, let's keep only strings to avoid notices.
This was referenced Mar 28, 2023
Closed
Open
@github-actions
Copy link
Contributor

github-actions bot commented Jul 7, 2023

This PR has been marked as stale. This happened because:

  • It has been inactive in the past 3 months.
  • It hasn’t been labeled `[Pri] BLOCKER`, `[Pri] High`, etc.

No further action is needed. But it's worth checking if this PR has clear testing instructions, is it up to date with trunk, and it is still valid. Feel free to close this PR if you think it's not valid anymore — if you do, please add a brief explanation.

@jeherve
Copy link
Member Author

jeherve commented Jul 7, 2023

Closing for now, we can reopen once we have a decision.

@jeherve jeherve closed this Jul 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@jeherve jeherve

Labels
[Block] AI Image [Block] Pay With Paypal aka Simple Payments DO NOT MERGE don't merge it! [Focus] Blocks Issues related to the block editor, aka Gutenberg, and its extensions developed in Jetpack [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Pri] Normal [Status] Proposal [Type] Bug When a feature is broken and / or not performing as intended
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Non-plain-text block description is being deprecated in WordPress 6.2
2 participants
@jeherve @anomiex