Skip to content

✂️ UX Paper Cuts 17.4 → Comments & system notes

Below is a list of potential candidates for this milestone based on existing issues. It is not expected to burn down all of these and the UX Paper Cuts team is not limited to this list. If you have suggestions for us please add a comment linking to an issue.

From proposal:

Comments & System notes

  • Potentially tweak design (unbox?)
  • Remove the mountain of CSS (over 1100 lines 😱) and start from scratch

Why?

  • Changing anything in notes.scss is a nightmare. It almost always causes unintentional bugs (so much so that reviewers are often reluctant to merge changes)
  • We could potentially unbox the design a bit while reducing the tech debt and making it easier to contribute in the future

Plan

Phase 1 --> CSS

  • Create new CSS file within page_bundles/notes for all the styles we can't use utility classes for
  • Append -v2 to every unique class you need to use
  • Use as many Tailwind utility classes as possible
  • Try not to nest things too deeply; we don't want to end up in the exact same place at the end of the milestone 😅
  • Don't remove anything from notes.scss (or any of the other existing stylesheets) unless they're only used in the note type you're refactoring and you've already replaced it with a utility class or a v2 class
  • Test thoroughly!

Phase 2

  • Remove old CSS files, see what breaks, fix it
  • Remove all -v2s from classes

Types of notes

Note type Vue/haml Assignee Status Merge request
System notes @annabeldunstone ✅ Rewrite system note CSS (!162639 - merged)
Work item system notes @annabeldunstone ✅ Use new CSS file for work items system notes (!163663 - merged)
System notes on diffs @annabeldunstone ✅ Done as part of other system note MRs
Standalone comments @seggenberger
Replies @seggenberger
Comments on diffs
Multiple threads on diffs
Pending comments @annabeldunstone 👀 Refactor draft notes CSS (!163676 - merged)
Confidential comments @clavimoniere 👀
Comments from external participants (Service Desk)
Comments with suggestions
Legacy notes (commits, snippets, etc) haml @annabeldunstone 🔧

Legend:

  • 🔧 In progress
  • 👀 In review
  • ✅ Merged

Links

Julia's issues

Chad's issues

The best way to follow Chad's planned work in this milestone is to see this board: https://gitlab.com/gitlab-org/gitlab/-/boards/7319859?assignee_username=clavimoniere&milestone_title=17.4

Edited by Julia Miocene