New issue
Advanced search Search tips
Note: Color blocks (like or ) mean that a user may not be available. Tooltip shows the reason.

Issue 835454 link

Starred by 2 users

Issue metadata

Status: Fixed
Owner:
Traveling - Back 2/6
Closed: Jul 18
Cc:
Components:
EstimatedDays: ----
NextAction: ----
OS: Linux , Android , Windows , iOS , Chrome , Mac
Pri: 2
Type: Bug

Blocked on:
issue 726400



Sign in to add a comment

Cleanup actions.xml for in-product help

Project Member Reported by nyquist@chromium.org, Apr 20 2018

Issue description

Chrome Version: (copy from chrome://version)
OS: All

What steps will reproduce the problem?
(1) Follow steps for adding a new in-product help: https://chromium.googlesource.com/chromium/src/+/master/components/feature_engagement/README.md#Configuring-UMA

What is the expected result?
I add one more line with my new in-product help feature in actions.xml.

What happens instead?
I have to copy-paste 6 different actions, which is error prone and should be unnecessary.

Notes:
When https://chromium-review.googlesource.com/c/chromium/src/+/1015293/ lands, we should be able to do that. We should then update the documentation. Also, we should consider filing a bug to moving the suffix-list to a separate file with its own OWNERS, etc.


The core work to fix this bug is to clean up all the old IPH actions, and consolidate them to using the new framework.
 
Project Member

Comment 1 by bugdroid1@chromium.org, Jul 16

The following revision refers to this bug:
  https://chromium.googlesource.com/chromium/src.git/+/c5c3c8cd1e92fbf4db57e5ddcc2467a4898b113a

commit c5c3c8cd1e92fbf4db57e5ddcc2467a4898b113a
Author: Tommy Nyquist <nyquist@chromium.org>
Date: Mon Jul 16 17:23:36 2018

Cleanup user actions for in-product help

Currently whenever we add a new in-product help feature, the developer
have to add six distinct <action> entries, which makes it easy to
overlook something. Also, these actions are typically copy-pasted from
an old entry, so they do not typically provide any good documentation
for the particular in-product help feature either.

This CL uses the new functionality introduced in
https://chromium-review.googlesource.com/c/chromium/src/+/1015293
which fixes the fan-out for user actions, making them usable for
chromium.

For all known in-product help entries, this CL moves them to the suffix
list at the bottom of the file. This means that the action suffix list
will be defined for a few extra, since not all of them was in use for
the user actions that have already been moved to the new system.

BUG= 835454 

Change-Id: I72847cda991413e85c6b6e990af1f2e9e0f0cd8e
Reviewed-on: https://chromium-review.googlesource.com/1136976
Reviewed-by: Alexei Svitkine <asvitkine@chromium.org>
Commit-Queue: Tommy Nyquist <nyquist@chromium.org>
Cr-Commit-Position: refs/heads/master@{#575324}
[modify] https://crrev.com/c5c3c8cd1e92fbf4db57e5ddcc2467a4898b113a/components/feature_engagement/README.md
[modify] https://crrev.com/c5c3c8cd1e92fbf4db57e5ddcc2467a4898b113a/tools/metrics/actions/actions.xml

asvitkine: Should the action suffixes list be moved to a separate file and OWNERS policy, or should it be kept where it is right now?
I think the changes to these is low-traffic enough that it's fine to keep as-is. Moving them out adds complexity which is not warranted given the low traffic, imo.
Status: Fixed (was: Assigned)
SGTM!

Sign in to add a comment