search

Parsely / wp-parsely

The official WordPress plugin for Parse.ly - makes it a snap to add the required tracking code to enable Parse.ly on your WordPress site.
https://wordpress.org/plugins/wp-parsely/
GNU General Public License v2.0
62 stars 31 forks source link

PCH Smart Linking: Add additional Telemetry to the new Smart Linking interface #2605

Closed vaurdan closed 1 month ago

vaurdan commented 1 month ago

Description

This PR adds additional telemetry to the new Smart Linking interface. There are 7 new events that can be thrown, as shown in the table below.

Event Name Properties Explanation
smart_linking_review_pressed - num_smart_links: Number of smart links present.
- has_fixed_links: Indicates if there are fixed smart links.
- context: Contextual information.		 Triggered when the "Review Smart Links" button is pressed.
smart_linking_open_in_editor_pressed - type: Type of link (inbound).
- uid: Unique identifier for the link.		 Triggered when the "Open in the Editor" button is clicked for an inbound smart link.
smart_linking_link_accepted - link: The URL of the accepted link.
- title: The title of the accepted link.
- text: The text associated with the accepted link.
- uid: Unique identifier for the link.		 Triggered when a smart link is accepted and applied to a block.
smart_linking_link_rejected - link: The URL of the rejected link.
- title: The title of the rejected link.
- text: The text associated with the rejected link.
- uid: Unique identifier for the link.		 Triggered when a smart link is rejected.
smart_linking_link_removed - link: The URL of the removed link.
- title: The title of the removed link.
- text: The text associated with the removed link.
- uid: Unique identifier for the link.		 Triggered when a smart link is removed from a block.
smart_linking_select_in_editor_pressed - type: Type of link (outbound).
- uid: Unique identifier for the link.		 Triggered when the "Select in Editor" button is pressed for a outbound link.
smart_linking_modal_tab_selected - tab: The selected tab name.
- total_inbound: Total number of inbound links.
- total_outbound: Total number of outbound links.		 Triggered when a tab is selected in the smart linking review modal.

Motivation and context

Better tracking of the Smart Linking usage with the new interface.

How has this been tested?

Tested locally, and validated that each event was correctly triggered.

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago
Walkthrough ## Walkthrough This update introduces telemetry (usage tracking) to the smart linking features of the editor sidebar. Changes include tracking events like metrics on smart links, their status (fixed or not), and user interactions within the smart linking review modal. These modifications provide insightful analytics on how users interact with smart linking functionalities. ## Changes | Files | Change Summaries | |-------|------------------| | `src/.../smart-linking/component.tsx` | Introduced telemetry tracking for smart linking review events and user interactions within the `SmartLinkingPanel` component. | | `src/.../review-modal/component-inbound-link.tsx` and `src/.../review-modal/component-modal.tsx` | Added telemetry tracking for button clicks, and interactions with smart linking functionalities in the review modal. | | `src/.../review-modal/component-sidebar.tsx` | Introduced telemetry for tracking tab selection in the review modal sidebar, capturing details about selected tabs and link counts. |

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.