experimenter icon indicating copy to clipboard operation
experimenter copied to clipboard

For #7479: Updating sequence diagrams

Open eliserichards opened this issue 2 years ago • 1 comments

#7479 Related to #7867

This commit...

  • Updates the sequence diagrams to include rollouts update/dirty state
  • Shows the state, published state, and remote settings state more clearly for all published states
  • Since rollouts doesn't have an "end"/"completed" state, those diagram updates can come later

eliserichards avatar Oct 25 '22 20:10 eliserichards

Yeah, wrt the pause ones I want to take that out in a separate PR (filing that issue now... #7888)

Let me move the rollouts down to the Live section ✍️

eliserichards avatar Oct 28 '22 17:10 eliserichards

I went through and added more specificity when referring to experiments and/or rollouts :) Hopefully this makes it a little clearer 😄

eliserichards avatar Oct 31 '22 19:10 eliserichards

There's still a bunch of incorrect states and diagrams in here, but it looks like we can use Mermaid 🧜‍♀️ in the docs so we don't need to bother with this whole png screenshot situation. So let's close this in favour of https://github.com/mozilla/experimenter/issues/7956

jaredlockhart avatar Nov 16 '22 17:11 jaredlockhart

Since there were only a few things that needed to be fixed on these, we're going to get these landed now and work on 🧜‍♀️ when we have some more time

eliserichards avatar Nov 17 '22 22:11 eliserichards

Okay almost done! Couple things

* Under Update(Approve/Approve) it ends on Live/Idle/Live but I think idle should always have `next_status: <none>` right?

Yes, agree with that

* Now that I think about it, Dirty is kind of like an Idle state, since it hasn't really kicked off any kind of publish flow yet until it hits review.  So I see a bunch of places where the first thing it does is go `Live/Idle/None` to `Live/Dirty/Live`, but if we think of Dirty more like an idle state, then it should be `Live/Dirty/None`?  What do you think?

User publishes a rollout -> Live/Idle/None User changes population size -> Live/Dirty/None User clicks review -> Live/Review/Live

Yeah I think that makes sense to me. There will never be a state where it is Live/Dirty/Live

Actually I see in one of the reject flows it does land on Live/Dirty/None. So we should pick whether the 'post user edit, pre review request' state is Live/Dirty/Live or Live/Dirty/None, I think I prefer the latter, what do you think?

I totally agree, Live/Dirty/None makes the most sense to me there

eliserichards avatar Nov 17 '22 23:11 eliserichards

whoops, didn't mean to close that

eliserichards avatar Nov 17 '22 23:11 eliserichards