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

Create a new introduction for the new Elementor editor #21388

Conversation

leonidasmi
Copy link
Contributor

@leonidasmi leonidasmi commented May 16, 2024

Context

Summary

This PR can be summarized in the following changelog entry:

  • Helps guide Elementor users to Yoast when they have the new editor top bar activated.

Relevant technical choices:

  • I didn't abstract the introduction, thus causing some code duplication, because this should be a temporary solution, until the old Elementor editor gets phases out, but I can be conviced :)

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  • Activate Elementor and go to Elementor->Settings and turn Editor Top Bar to active
  • Go to edit a post
  • Confirm that you see the new introduction modal, right below the button with the cog icon:
    image
  • Check that modal in various screen sizes and confirm that it looks good.
  • Click on the Got it button, confirm that the modal disappears and after a refresh, confirm that it doesn't appear again
  • To make it appear again, you can search for the elementor_introduction usermeta of your user and delete it
  • Now, refresh and again confirm that you see the modal. This time, click on the gear icon, to open the Post settings (from where you can navigate to the Yoast tab)
  • Again, confirm that the modal disappears and after a refresh, confirm that it doesn't appear again.

Relevant test scenarios

  • Changes should be tested with the browser console open
  • Changes should be tested on different posts/pages/taxonomies/custom post types/custom taxonomies
  • Changes should be tested on different editors (Default Block/Gutenberg/Classic/Elementor/other)
  • Changes should be tested on different browsers
  • Changes should be tested on multisite

Test instructions for QA when the code is in the RC

  • QA should use the same steps as above.

QA can test this PR by following these steps:

Impact check

This PR affects the following parts of the plugin, which may require extra testing:

  • Smoke test the same introduction modal in the currently default Elementor editor.
  • To do so, you have to turn the Editor Top Bar setting to default or Inactive
  • It should like this:
    image

UI changes

  • This PR changes the UI in the plugin. I have added the 'UI change' label to this PR.

Other environments

  • This PR also affects Shopify. I have added a changelog entry starting with [shopify-seo], added test instructions for Shopify and attached the Shopify label to this PR.

Documentation

  • I have written documentation for this change. For example, comments in the Relevant technical choices, comments in the code, documentation on Confluence / shared Google Drive / Yoast developer portal, or other.

Quality assurance

  • I have tested this code to the best of my abilities.
  • During testing, I had activated all plugins that Yoast SEO provides integrations for.
  • I have added unit tests to verify the code works as intended.
  • If any part of the code is behind a feature flag, my test instructions also cover cases where the feature flag is switched off.
  • I have written this PR in accordance with my team's definition of done.
  • I have checked that the base branch is correctly set.

Innovation

  • No innovation project is applicable for this PR.
  • This PR falls under an innovation project. I have attached the innovation label.
  • I have added my hours to the WBSO document.

Fixes https://github.com/Yoast/reserved-tasks/issues/217

@leonidasmi leonidasmi added the changelog: enhancement Needs to be included in the 'Enhancements' category in the changelog label May 16, 2024
@leonidasmi leonidasmi changed the base branch from trunk to feature/plugin-fixes May 16, 2024 12:56
@coveralls
Copy link

coveralls commented May 16, 2024

Pull Request Test Coverage Report for Build 93e30c3c0083abe09dd81f27c5744b72e220962c

Details

  • 0 of 24 (0.0%) changed or added relevant lines in 2 files are covered.
  • 3706 unchanged lines in 106 files lost coverage.
  • Overall coverage decreased (-4.3%) to 48.302%

Changes Missing Coverage Covered Lines Changed/Added Lines %
packages/js/src/elementor.js 0 3 0.0%
packages/js/src/elementor/initializers/introduction-editor-v2.js 0 21 0.0%
Files with Coverage Reduction New Missed Lines %
admin/class-option-tabs-formatter.php 1 0.0%
src/actions/configuration/first-time-configuration-action.php 1 91.84%
src/builders/indexable-home-page-builder.php 1 98.0%
src/builders/indexable-term-builder.php 1 99.15%
src/context/meta-tags-context.php 1 28.29%
src/generators/breadcrumbs-generator.php 1 64.23%
src/generators/schema/webpage.php 1 90.32%
src/integrations/blocks/structured-data-blocks.php 1 16.0%
src/integrations/settings-integration.php 1 28.49%
src/integrations/watchers/indexable-ancestor-watcher.php 1 98.41%
Totals Coverage Status
Change from base Build 75c417121c6e8a9a79486f10ca17d91933f35221: -4.3%
Covered Lines: 24971
Relevant Lines: 53561

💛 - Coveralls

@leonidasmi leonidasmi changed the base branch from feature/plugin-fixes to trunk May 17, 2024 10:31
@leonidasmi leonidasmi marked this pull request as ready for review May 20, 2024 06:47
Copy link
Member

@enricobattocchi enricobattocchi left a comment

Choose a reason for hiding this comment

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

CR & Acc ✅

waiting for a check from @igorschoester or @vraja-pro

@vraja-pro
Copy link
Contributor

vraja-pro commented May 21, 2024

CR & ACC ✅

@vraja-pro vraja-pro merged commit 5ccfd26 into trunk May 21, 2024
15 of 16 checks passed
@vraja-pro vraja-pro deleted the 217-adapt-yoast-seo-for-elementor-notification-to-elementor-top-bar-navigation branch May 21, 2024 08:28
@vraja-pro vraja-pro added this to the 22.9 milestone May 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog: enhancement Needs to be included in the 'Enhancements' category in the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants