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

Site Editor: do not display Jetpack sidebar panels when not needed #37949

Merged
merged 3 commits into from
Jun 25, 2024

Conversation

jeherve
Copy link
Member

@jeherve jeherve commented Jun 19, 2024

Proposed changes:

Following recent changes in the Gutenberg plugin, we currently display some Jetpack sidebar panels in the site editor, when they do not make sense because they would only apply to specific posts or pages:

  • The QR code panel
  • The Social Previews panel
  • The SEO Tools panel
  • The AI Assistant panel.

While Gutenberg will address that issue in WordPress/gutenberg#62531, it would be nice for us to add a safeguard, as recommended here:
https://make.wordpress.org/core/2024/06/18/editor-unified-extensibility-apis-in-6-6/

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

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

  • No

Testing instructions:

You can test this on a site running the Gutenberg plugin version 18.5.

  • Go to Appearance > Editor
  • Check if there are any Jetpack sidebar elements.
    • You should see none with this PR applied.

@jeherve jeherve added [Type] Bug When a feature is broken and / or not performing as intended [Status] In Progress [Pri] Normal [Focus] FSE Issues related to the site editor / Full Site Editing / FSE feature in Gutenberg labels Jun 19, 2024
@jeherve jeherve self-assigned this Jun 19, 2024
Copy link
Contributor

github-actions bot commented Jun 19, 2024

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

  • To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the update/editor-api-66 branch.

  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack update/editor-api-66
    

Interested in more tips and information?

  • In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
  • Read more about our development workflow here: PCYsg-eg0-p2
  • Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

@github-actions github-actions bot added [Extension] AI Assistant Plugin [Extension] Post Publish QR Post Panel [Extension] SEO [Extension] Social Previews Social Preview block editor plugin [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ labels Jun 19, 2024
Copy link
Contributor

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.
  • ✅ 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 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 reviewed, it can then be merged.
If you need an extra review from someone familiar with the codebase, you can update the labels from "[Status] Needs Team Review" to "[Status] Needs Review", and in that case Jetpack Approvers will do a final review of your PR.


Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

  • WordPress.com Simple releases happen daily.
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for July 2, 2024 (scheduled code freeze on July 1, 2024).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

@jeherve jeherve force-pushed the update/editor-api-66 branch from 75404e3 to b2c3ca6 Compare June 19, 2024 12:46
// If the post type is not viewable, do not render my plugin.
if ( ! isViewable ) {
return null;
}
Copy link
Contributor

Choose a reason for hiding this comment

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

We're using AI Assistant panel in other places (Document Settings, Pre-Publish) than Jetpack Sidebar, we should trigger an early return and remove it from all places?

Copy link
Member Author

Choose a reason for hiding this comment

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

Pre-Publish shouldn't be a concern here since it's not displayed in the site editor. I'm thinking Document Settings may still be valuable (and work) in the site editor though; what do you think?

Copy link
Contributor

Choose a reason for hiding this comment

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

@jeherve Thinking better about, don't think any of the current features we have on AI suits good with Site Editor. I think we're good on the early return. If we change the mind in the future we can return and update cc/ @Automattic/jetpack-agora

Copy link
Member Author

Choose a reason for hiding this comment

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

Does this mean we should add early returns elsewhere in addition to what I've added here?

Copy link
Contributor

Choose a reason for hiding this comment

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

@jeherve don't think so, this is the entry for all features that lives on the sidebar.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, current features do not suit the Site Editor. Breve could be an exception later on, but that is for the future us.

Copy link
Contributor

@monsieur-z monsieur-z left a comment

Choose a reason for hiding this comment

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

The PR tests as advertised and the code changes look good.

It may be worth creating a dedicated hook to avoid duplication if the code is here to stay.

@jeherve
Copy link
Member Author

jeherve commented Jun 20, 2024

It may be worth creating a dedicated hook to avoid duplication if the code is here to stay.

That's a good point. I suspect we may not need that code in the long run, since the post editor and site editor will be more separated in the future, but I'll keep it in mind.

@jeherve jeherve enabled auto-merge (squash) June 25, 2024 08:39
@jeherve jeherve merged commit 5e6d88d into trunk Jun 25, 2024
54 checks passed
@jeherve jeherve deleted the update/editor-api-66 branch June 25, 2024 08:49
@github-actions github-actions bot added this to the jetpack/13.6 milestone Jun 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Extension] AI Assistant Plugin [Extension] Post Publish QR Post Panel [Extension] SEO [Extension] Social Previews Social Preview block editor plugin [Focus] FSE Issues related to the site editor / Full Site Editing / FSE feature in Gutenberg [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Pri] Normal [Type] Bug When a feature is broken and / or not performing as intended
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants