Cycle analytics: events per stage

Description

We've shipped Cycle Analytics in 8.12 and we are going to make it better. It would be great to display all the events for each of the stage of Cycle analytics for a project.

Specification

The "events" per stage stay the same as previously defined.

• Issue: list of issues created in the last XX days, that have been labeled or added to a milestone.
• Plan: list of commits that reference for the fist time an issue from the last stage.
• Code: list of MR created in this stage
• Test: List of unique builds triggered by the commits.
• Review: List of MR merged
• Staging: List of deployed builds
• Production: list of issues with the time from idea to production

Design

Issue

Plan

Code

Test

Review

Staging

Production

Issue

Plan

Code

Test

Review

Staging

Production

Tooltip pattern

Mentioned in issue #22458 (closed)

Mentioned in merge request !6859 (merged)

@regisF are we using the new wording, the one we prepared here: https://docs.google.com/a/gitlab.com/document/d/1fHi_HaNVfP1CDaI1YR9V1v3LtGs6ntoiWnpnK3wzNWg/edit?usp=sharing ?

It's important that we know, bc perhaps would be necessary to update the documentation and the post. If not, I'd also tell Amara she doesn't need to review it. ;)

Nothing has been done in the front end yet, but @alfredo1 has to take care of this :-)

Thanks @regisF!

@regisF I'm working on the frontend with fake data for now meanwhile the backend is getting done

Added ~307500 label

Mentioned in issue #22689 (closed)

Reassigned to @jameslopez

@hazelyang we need one other thing that we haven't covered yet but it's still needed in this issue.

What do we show when a stage has no events because we don't have enough data?

Here is what I think we should do. Can you pimp this? Thanks!

@regisF Added a small illustration to it. 🙂

@regisF random thought! Would enough data be confusing for users? They may think they just need to do more pushes, MRs, etc... in order to get the numbers there. But it could be that they are just not following the expected workflow....

@awhildy can you help us with @jameslopez very pertinent comment?

Thanks @regisF! @jameslopez: good call!

What if the header text was: We don't have enough of the right data
I think the 'to show this stage' is implied by the location and context of the text.

Would it also make sense to link to documentation on the expected workflow in the body text? Maybe at the end of the body text, add something like:
"Learn more about the expected workflow and calculations."

@awhildy Yes indeed, a link to the documentation should be included, definitely.

About the text on the left part of the screen, is Not enough data right, or can we have some kind of visuals to represent emptyness? I struggle to find something that would immediately make sense.

Oops, missed the text on the left! 😊

Could it just say 'Not available' on the left, and when you click on it, you get the longer description that explains why, with a link to the documentation? @regisF

Since all the table headers are written out, maybe Δ should just say Delta to match? I know my original comps for CA included the icon, but there seems to more room now since perc 95 isn't included (unless we are adding that later?).

@tauriedavis Agreed. Modified it. 🙂

@awhildy Something like this? 🤓

@hazelyang @regisF Currently we display this message to introduce Cycle Analytics to users until the user dismiss the message.

And with this new iteration we'll display this message when there's no data

If Cycle Analytics is already set and is displaying data do we need to display the "Introducing to Cycle analytics" message? I'm a bit confused when to display each message can someone explain to me?

Great question @alfredo1. I think we only ever need to display one. The "There is nothing happened." message also needs some copy editing.

• If a user has no CA data, show:

Introducing Cycle Analytics

Cycle Analytics gives an overview of how much time it takes to go from idea to production in your project. To set up CA, you must first define a production environment by setting up your CI and then deploy to production.

[Read more]

[graphic]

• If a user has CA data, but is new to CA, show the small message up top until they dismiss it:

Introducing Cycle Analytics

Cycle Analytics gives an overview of how much time it takes to go from idea to production in your project.

[Read more]

---

Thoughts @hazelyang?

@regisF @marcia Can I get the copy for every tooltip please.

@tauriedavis Agreed that we should have different copies depends on there already has data or not. 😃

If a user has no CA data, show:

I think we can have an empty state like other pages we did for a user has no CA data. What do you think?

If a user has CA data, but is new to CA, show the small message up top until they dismiss it:

@alfredo1 they're here: https://docs.google.com/a/gitlab.com/document/d/1fHi_HaNVfP1CDaI1YR9V1v3LtGs6ntoiWnpnK3wzNWg/edit?usp=sharing

cc/ @regisF

thank you @marcia

You're welcome, Alfredo! 😊

Mentioned in merge request !7366 (merged)

@axil @marcia are the docs ready for this change and do you need any help from my side? I'm working on the MR for this issue - https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/6859 - which is almost ready to be reviewed.

@jameslopez I think we will need to change the description of each stage according to https://docs.google.com/a/gitlab.com/document/d/1fHi_HaNVfP1CDaI1YR9V1v3LtGs6ntoiWnpnK3wzNWg/edit?usp=sharing. Also can you check whether something changed in the current implementation as to how the data is measured https://docs.gitlab.com/ce/user/project/cycle_analytics.html#how-the-data-is-measured?

And finally, I guess we'll need to change the images as well :)

@axil thanks!

So are those tooltip descriptions final? Shall we reuse the same wording for the description ?

Re - https://docs.gitlab.com/ce/user/project/cycle_analytics.html#how-the-data-is-measured nothing has changed there since my last edit.

Re - images. Let's wait for confirmation from @alfredo1 that everything is good from the frontend, as I haven't see the changes in action (just done the backend bit) 😃

@jameslopez

So are those tooltip descriptions final? Shall we reuse the same wording for the description ?

I believe they are yes :) We can always change later, let's go with what we currently have.

Re - https://docs.gitlab.com/ce/user/project/cycle_analytics.html#how-the-data-is-measured nothing has changed there since my last edit.

Awesome!

Re - images. Let's wait for confirmation from @alfredo1 that everything is good from the frontend, as I haven't see the changes in action (just done the backend bit) 😃

That makes sense, it was just an fyi :)

---

Thanks again!

@axil @jameslopez Frontend related MR here https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/7366 Unfortunately it will not work for you since I'm using a local server to provide fake data in JSON. Looking forward to !6859 (merged) to get merged to start using real data.

The design for the user without the permission to access the test and staging data.

Status changed to closed by merge request !6859 (merged)

Mentioned in commit tnir/gitlab-ce@2343b830

Mentioned in commit 7e8f15fd

@jameslopez MR with the frontend for this issue is ready to be reviewed however there are some minor things left.

• Boolean variable to determine if we should display "Introducing Cycle Analytics" message. Right now the variable is named @cycle_analytics_not_set_upon cycle_analytics/show-html.haml ref: https://gitlab.com/gitlab-org/gitlab-ce/issues/23449#note_17768296
• Expose boolean property to indicate user permission for each stage on /:namespace_id/:project_id/cycle_analytics JSON endpoint. It has to be here because I need that info before load stage events.
• Branch dropdown in test stage to filter results by branch.
• Add tests.

I think the first two are required to ship on 8.14 I can add the other two within the following patch releases.

/cc @regisF @DouweM

@jameslopez I forgot to mention https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/6859#note_18645528

@alfredo1 I wonder if https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/6859#note_18645528 is correct - For the test stage, we have a list of builds. If the link is to the pipeline, then there would be builds that will link to the same place. If that's fine, then all good!

@alfredo1 re - @cycle_analytics_not_set_up, I assume this not for the empty data state, but it's true until the user dismisses the message ? I think we could choose a better name or it could even be a new endpoint...

This will require adding a new table in the DB and having 2 endpoints. When the user dismisses the message, the backend needs to know so and update the flag in the DB. This is what I understand from https://gitlab.com/gitlab-org/gitlab-ce/issues/23449#note_17768296 - correct me if I'm wrong...

Mentioned in merge request !7613 (merged)

Mentioned in merge request gitlab-com/www-gitlab-com!3851 (merged)

@alfredo1 actually, looking at your code it looks like @cycle_analytics_not_set_up is for the first case, where there's no data. If that's the case, it should be much easier - I'll create a MR for that just in case.

Mentioned in merge request !7622 (merged)

Mentioned in commit 9c31ef8e