[Connect 2.5] Workstreams - Design Review

[maxceem]

We have to implement UI to review design inside works. And here we can discuss the requirements.

[maxceem]

1. In the new design, I see the UI for reviewing design submissions. But I don't see the UI for copilots to add such design submissions. How we would add them before letting a customer to review them?

[maxceem]

2. When we provide feedback we use a rich text editor as per design https://marvelapp.com/54cf844/screen/59214106
   That's good for copilots, so they can see the formatted text in Connect. Though as I understand copilots after share the feedback with the members. And I'm not sure how they do this. If they post the feedback on the forum then, formating would be lost. Thus it's better to not let it format here, as the inputted format would be different from what the memebrs would see. So if members would see just plain text, I would suggest to keep feedback as plain text here too. So when customer input the feedback they would format it accordingly.

[maxceem]

3. Customers can choose up to 5 works on this page https://marvelapp.com/54cf844/screen/59214106 or edit placement on this page https://marvelapp.com/54cf844/screen/59214115.
   How customers can mark the review as complete? I guess it shouldn't be automatically as we never know if a customer already did the final decision, or still thinking and wants to change anything.

[vikasrohit]

1. Good catch. For now, can we use our existing way to add design submission?

2. I think most of the copilots does not do simply copy paste of the feedback to the members. They parse the feedback and explain that to the members in probably a different way. So, I guess, we can keep the customer feedback formatted for the copilots/CAs.

3. Just fyi, https://marvelapp.com/54cf844/screen/59214106 is our current checkpoint-review (where we don't need the placement) and https://marvelapp.com/54cf844/screen/59214115 is our current final-designs (where placement matters).
   Lets put a button for now to mark the review complete. May be we can put a button just below the General feedback and before the Individual feedback section. I am going to get more details from the product management team as well for this.

[maxceem]

1. Good catch. For now, can we use our existing way to add design submission?

I think that wouldn't work. In the old UI, we add one link per design. But in the new UI we should add

• submission preview
• submission title
• several links

Maybe I can run parallel challenges to upload the list of submission and to review submissions. If one challenge to do both things would be too big.
I can quickly create some design for such UI based on what we have before.

[vikasrohit]

Yep, that is my intent. I meant that we have to use something similar from our existing designs. I have asked the product managers and they are getting the designs worked by design team. So, we have to just assume a very simple design to achieve this for now, which we can improve later on, once we have the designs.

[maxceem]

@vikasrohit I'm proposing the next design for adding design links:

[vikasrohit]

I am good with the designs. Thanks for the extra efforts @maxceem

[maxceem]

5. Regarding the RichTextEditor which we should use during the review https://marvelapp.com/54cf844/screen/59214106. As I see, the component which we have in Connect App for editing RichText is quite hard to reuse and it's tailored for comments. So as it's not easy to reuse it, I would prefer not to include it to the challenge for implementing main review functionality as it's already quite complex. Would it be ok, to release 2.5 without rich text editor and add it later? Probably in 2.5.1 or 2.5.2.

[vikasrohit]

I think we would need the feature to manage the requirements in 2.5. How difficult it is to simply use a new rich text editor which we evaluated earlier and just use that for Requirements tab of work card and general feedback of review milestone?

btw, I was looking at the RichTextEditor component and I found it not much coupled with comments except https://github.com/appirio-tech/connect-app/blob/feature/workstreams-workitems/src/components/RichTextArea/RichTextArea.jsx#L284 and https://github.com/appirio-tech/connect-app/blob/feature/workstreams-workitems/src/components/RichTextArea/RichTextArea.jsx#L141, which I think is easy to to refactor. Please correct me if I am missing something here.

[maxceem]

I think we would need the feature to manage the requirements in 2.5. How difficult it is to simply use a new rich text editor which we evaluated earlier and just use that for Requirements tab of work card and general feedback of review milestone?

I'm not sure yet. So I would prefer to start with a single place on the requirements tab. And if works good, we may use it for other places.
Also, there is one tricky moment. Currently, our editor saves data in markdown format. The ckeditor5 supports it as an experimental feature and still suggests to stick to the HTML format for storing richtext data https://ckeditor.com/docs/ckeditor5/latest/features/markdown.html.
So it's better to evaluate first how good it works with markdown format.

So I think I'll ask to reuse existent RichTextEditor for now for editing reviews. I think you are right, maybe it's not that hard to reuse it here.

[vikasrohit]

Good catch before implementing the CKEditor. I would prefer using our own RichTextEditor for Requirements tab as well once we are able to decouple it from comments completely.

[maxceem]

I would prefer using our own RichTextEditor for Requirements tab as well once we are able to decouple it from comments completely.

Yeah, we can do that for now. Though the week point of our editor is that it doesn't support mobile devices which other copilots and I personally would like to be able to use.

[maxceem]

6. I've noticed that here we are showing submission ids for on the previous:

   

   Should we add them? If yes, then we should add one more field when we enter designs: