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

Fix two issues in devdocs #94719

Merged
merged 2 commits into from
Sep 20, 2024
Merged

Fix two issues in devdocs #94719

merged 2 commits into from
Sep 20, 2024

Conversation

gikaragia
Copy link
Contributor

Fixes #94711

Overview

This PR fixes a couple of issues that were observed while testing this PR

The issues were:

  • The VerticalMenu wasn't working, see linked issue
  • The search state selectors wasn't working.

To reproduce the State Selectors issue:

  1. Navigate to https://wpcalypso.wordpress.com/devdocs/selectors
  2. Try a search
  3. Observe that the results are broken:

Screenshot 2024-09-19 at 14 45 33

Proposed Changes

  • Removes twitter which was deprecated from VerticalMenu
  • The results returned from the search API now include an item attribute. Updated calling code to use the attribute.

Testing Instructions

Pre-merge Checklist

  • Has the general commit checklist been followed? (PCYsg-hS-p2)
  • Have you written new tests for your changes?
  • Have you tested the feature in Simple (P9HQHe-k8-p2), Atomic (P9HQHe-jW-p2), and self-hosted Jetpack sites (PCYsg-g6b-p2)?
  • Have you checked for TypeScript, React or other console errors?
  • Have you used memoizing on expensive computations? More info in Memoizing with create-selector and Using memoizing selectors and Our Approach to Data
  • Have we added the "[Status] String Freeze" label as soon as any new strings were ready for translation (p4TIVU-5Jq-p2)?
  • For changes affecting Jetpack: Have we added the "[Status] Needs Privacy Updates" label if this pull request changes what data or activity we track or use (p4TIVU-aUh-p2)?

@gikaragia gikaragia requested a review from a team September 19, 2024 13:51
@matticbot matticbot added the [Status] Needs Review The PR is ready for review. This also triggers e2e canary tests and wp-desktop tests automatically. label Sep 19, 2024
@matticbot
Copy link
Contributor

matticbot commented Sep 19, 2024

Here is how your PR affects size of JS and CSS bundles shipped to the user's browser:

Async-loaded Components (~3 bytes added 📈 [gzipped])

name                          parsed_size           gzip_size
async-load-design-playground        -33 B  (-0.0%)       -5 B  (-0.0%)
async-load-design                   -33 B  (-0.0%)       -5 B  (-0.0%)
async-load-docs-selectors           +24 B  (+0.5%)       +8 B  (+0.5%)

React components that are loaded lazily, when a certain part of UI is displayed for the first time.

Legend

What is parsed and gzip size?

Parsed Size: Uncompressed size of the JS and CSS files. This much code needs to be parsed and stored in memory.
Gzip Size: Compressed size of the JS and CSS files. This much data needs to be downloaded over network.

Generated by performance advisor bot at iscalypsofastyet.com.

Copy link
Contributor

@TimBroddin TimBroddin left a comment

Choose a reason for hiding this comment

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

The unit tests & E2E tests seem to fail, but unrelated issues (probably flaky tests). You might want to rerun them before merging.

State Selectors:

CleanShot 2024-09-19 at 15 59 13@2x

VericalMenu:

CleanShot 2024-09-19 at 15 59 22@2x

I noticed the usage docs for VerticalMenu still mention twitter. If you want to change it, I'll reapprove.

CleanShot 2024-09-19 at 16 00 14@2x

@matticbot
Copy link
Contributor

This PR modifies the release build for the following Calypso Apps:

For info about this notification, see here: PCYsg-OT6-p2

  • blaze-dashboard
  • command-palette-wp-admin
  • help-center
  • notifications
  • odyssey-stats
  • whats-new
  • wpcom-block-editor

To test WordPress.com changes, run install-plugin.sh $pluginSlug fix/docs-issues on your sandbox.

@gikaragia
Copy link
Contributor Author

Good catch! Fixed!

@gikaragia gikaragia merged commit ef95cc4 into trunk Sep 20, 2024
11 checks passed
@gikaragia gikaragia deleted the fix/docs-issues branch September 20, 2024 08:09
@github-actions github-actions bot removed the [Status] Needs Review The PR is ready for review. This also triggers e2e canary tests and wp-desktop tests automatically. label Sep 20, 2024
niranjan-uma-shankar pushed a commit that referenced this pull request Sep 20, 2024
* Handle item attribute in selector search

* Remove twitter from vertical menu
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

VerticalMenu crashes in dev docs
3 participants