FY21-Q3 Technical Writing Mgmt/Staff OKR: Contribute to migrating Vue instances to Pajamas
Part of the FY21-Q3 UX Department OKRs
FY21Q3 IACV UX Dashboard: Make GitLab Pajamas First
-
Objective: As a Technical Writing team, contribute to the UX Department's work to migrate UI component instances:
"Improve GitLab performance, quality, and velocity by making GitLab development Pajamas first" (gitlab-com&758 (closed)). - Key Result: Migrate 25% (107) of the 427 deprecated-component instances identified in gitlab-com&758 (closed).
Current tally (as of Oct 29): 77 completed issues for migrations (72% of goal)
Continuing work on this OKR for FY21-Q4 is being tracked in a separate issue.
Background
- Every Technical Writer and TW Manager will complete some of the UX Department's component instance migrations in the form of frontend code MRs. While contributing to the broader effort, this will offer Technical Writers more experience in the codebase, typically in code that's relevant to their assigned stage groups.
- Issues have already been created for each component instance (e.g. a specific button or dropdown) that needs work.
- The first type of component to have prerequisites/instructions in its epic is the most common one:
GlDeprecatedButton
(&3459 (closed)).- We'll start with issues from that epic. Each TW should self-assign 2 for completion in August 2020 before taking on further issues from this or other epics through the quarter. At least half of your issues for the quarter can come from this epic.
OKR Process
- TWs should self-assign 6-8 issues throughout the quarter; not all at once, but one or two open issues at a time.
For an idea of how TW issue completion might contribute to the OKR:
- 8 each x 13 people = 104 issues (97%)
- Try to choose component instances that are in your product area. (This may not be possible for some writers based on your assigned stage/groups, and if that's the case, pick items to work on as you see fit.) You can often identify these by referencing the path of the Vue file in the issue description. To browse issues by Vue file, see this sheet.
- You may want to try to take issues that have been reviewed for complexity and given a low weight (1 or 2).
- You will need to view/screenshot component instances in GDK. Some may not be visible without additional setup in GDK. You can check with the relevant group UX Designer or Frontend Engineer before getting started or if you need any help along the way.
- Assign yourself issues and also add them to the table in this issue.
-
@cnorris is responsible for ensuring that work is assigned and tracked for the team:
@aqualls @sselhorn @eread @rdickenson @marcel @cnorris @susantacker @axil @marcia @msedlakjakubowski @mjang1 @ngaskill
MR Process and Tips
Refer to the process described at &3459 (closed).
Be sure to add anything you've learned to that process, both for your own and others' benefit.
Component instances reference
To more easily view the relevant issues and epics:
-
KR: Migrate Vue instances of buttons and pagination to Pajamas
(254 total)
- Buttons > Vue > Migrate GlDeprecatedButton instances to GlButton in GitLab - (165 total - 1 unassigned)
-
Buttons > Vue > Migrate LoadingButton instances to GitLab UI’s GlButton in GitLab- (23 total) -
Buttons > Vue > Migrate Bootstrap button to GitLab UI GlButton in vue components- (65 total) -
GlPagination: Update design management toolbar to use GlPagination- (1 total)
-
KR: Migrate Vue instances of dropdowns, modals, and tabs
(45 total)
-
Dropdowns > Vue > Migrate GlDeprecatedDropdown to GlDropdown in GitLab(32 total) - Dropdowns > Vue > Migrate Bootstrap dropdown to GitLab UI GlDropdown in vue components (20 total - 2 unassigned)
-
Modals > Vue > Migrate DeprecatedModal to GitLab UI Modal(7 total) - Modals > Vue > Migrate DeprecatedModal2 to GitLab UI Modal (14 total - 3 unassigned)
- Modals > Vue > Migrate data-toggle modals to GitLab UI Modals in vue (13 total - 11 unassigned)
- Tabs > Vue > Migrate custom implementations to GlTabs in GitLab (11 total - 2 unassigned)
-
-
KR: Migrate Vue instances of popovers and tooltips to Pajamas (74 total)
- Popovers > Vue > Migrate popover directive to GitLab UI GlPopover in vue (5 total - Still determining how to do)
- Popovers > Vue > Migrate Bootstrap popover to GitLab UI GlPopover in vue (6 total - Still determining how to do)
-
Tooltips > Vue > Migrate vue_shared tooltip to GitLab UI GlTooltip in vue(59 total) -
Tooltips > Vue > Migrate Bootstrap tooltip to GitLab UI GlTooltip in vue(4 total)
Lessons learned
Assignments
Issue | Type | TW | Status | Result |
---|---|---|---|---|
gitlab#219762 (closed) | GlDeprecatedButton to GlButton | Marcel | gitlab!38757 (merged) | |
gitlab#219775 (closed) | GlDeprecatedButton to GlButton | Marcel | gitlab!38763 (merged) | |
gitlab#219794 (closed) | GlDeprecatedButton to GlButton | Marcel | gitlab!38770 (merged) | |
gitlab#219799 (closed) | GlDeprecatedButton to GlButton | Marcel | gitlab!39311 (merged) | |
gitlab#229315 (closed) | Bootstrap Button to GlButton | Marcel | gitlab!41557 (merged) | |
gitlab#229335 (closed) | Bootstrap Button to GlButton | Marcel | gitlab!41557 (merged) | |
gitlab#229295 (closed) | Bootstrap Button to GlButton | Marcel | gitlab!45862 (closed) | |
gitlab#228991 (closed) | vue_shared to GitLab UI’s tooltip | Marcel | gitlab!43813 (merged) | |
gitlab#228968 (closed) | vue_shared to GitLab UI’s tooltip | Marcel | gitlab!43818 (merged) | |
gitlab#229004 (closed) | vue_shared to GitLab UI’s tooltip | Marcel | gitlab!43822 (merged) | |
gitlab#229015 (closed) | vue_shared to GitLab UI’s tooltip | Marcel | gitlab!43859 (merged) | |
gitlab#228986 (closed) | vue_shared to GitLab UI’s tooltip | Marcel | gitlab!44375 (merged) | |
gitlab#228989 (closed) | vue_shared to GitLab UI’s tooltip | Marcel | gitlab!44539 (merged) | |
gitlab#228976 (closed) | vue_shared to GitLab UI’s tooltip | Marcel | gitlab!44678 (merged) | |
gitlab#228977 (closed) | vue_shared to GitLab UI’s tooltip | Marcel | gitlab!44869 (merged) | |
gitlab#219909 (closed) | GlDeprecatedButton to GlButton | Susan | gitlab!38351 (merged) | |
gitlab#219804 (closed) | GlDeprecatedButton to GlButton | Marcin | File deleted previously. | |
gitlab#219811 (closed) | GlDeprecatedButton to GlButton | Marcin | gitlab!34109 (merged) | |
gitlab#219895 (closed) | GlDeprecatedButton to GlButton | Marcin | gitlab!39460 (merged) | |
gitlab#229290 (closed) | Bootstrap button to GlButton | Marcin | gitlab!41894 (merged) | |
gitlab#229319 (closed) | Bootstrap button to GlButton | Marcin | File deleted previously. | |
gitlab#229328 (closed) | Bootstrap button to GlButton | Marcin | Done independently by dev. | |
gitlab#229301 (closed) | Bootstrap button to GlButton | Marcin | gitlab!45780 (merged) | |
gitlab#229695 (closed) | deprecatedModal2 to GlModal | Marcin | gitlab!46149 (merged) | |
gitlab#235379 (closed) | Bootstrap dropdown to GlDropdown | Marcin | gitlab!46139 (closed) - MR closed, will be fixed by a dev | |
gitlab#219786 (closed) | GlDeprecatedButton to GlButton | Nick & Marcia | gitlab!43724 (merged) | |
gitlab#219858 (closed) | GlDeprecatedButton to GlButton | Nick | File deleted previously. | |
gitlab#233591 (closed) | GlDeprecatedDropdown to GlDropdown | Nick | File no longer in use, to be removed by frontend engineer. | |
gitlab#229018 (closed) | vue tooltip to GlTooltip |
Nick & Marcel | gitlab!43926 (merged) | |
gitlab#219800 (closed) | GlDeprecatedButton to GlButton | Evan | gitlab!39561 (merged) | |
gitlab#219836 (closed) | GlDeprecatedButton to GlButton | Evan | gitlab!39560 (merged) | |
gitlab#219829 (closed) | GlDeprecatedButton to GlButton | Evan | gitlab!39284 (merged) | |
gitlab#219856 (closed) | GlDeprecatedButton to GlButton | Evan | gitlab!40806 (merged) | |
gitlab#229338 (closed) | Bootstrap button to GlButton | Evan | gitlab!43061 (merged) | |
gitlab#229311 (closed) | Bootstrap button to GlButton | Evan | gitlab!43072 (merged) | |
gitlab#235380 (closed) | Bootstrap dropdown to GitLab UI GlDropdown | Evan | gitlab!43505 (merged) | |
gitlab#229021 (closed) | vue_shared tooltip with GitLab UI’s tooltip | Evan | gitlab!44867 (merged) | |
gitlab#229008 (closed) | vue_shared tooltip with GitLab UI’s tooltip | Evan | gitlab!44871 (merged) | |
gitlab#229010 (closed) | vue_shared tooltip with GitLab UI’s tooltip | Evan | gitlab!44874 (merged) | |
gitlab#229012 (closed) | vue_shared tooltip with GitLab UI’s tooltip | Evan | gitlab!45972 (merged) | |
gitlab#235361 (closed) | Bootstrap dropdown to GitLab UI GlDropdown | Evan | gitlab!46193 (merged) | |
gitlab#219759 (closed) | GlDeprecatedButton to GlButton | Russell | gitlab!40341 (merged) | |
gitlab#219781 (closed) | GlDeprecatedButton to GlButton | Russell | Taken over by dev. | |
gitlab#219795 (closed) | GlDeprecatedButton to GlButton | Russell | gitlab!40331 (merged) | |
gitlab#229340 (closed) | Bootstrap to GlButton | Russell | gitlab!42550 (merged) | |
gitlab#229281 (closed) | Bootstrap to GlButton | Russell | gitlab!46105 (merged) | |
gitlab#229282 (closed) | Bootstrap to GlButton | - | ||
gitlab#228969 (closed) | Tooltip migration | Russell | gitlab!45354 (merged) | |
gitlab#228965 (closed) | Tooltip migration | Russell | Tooltip currently broken in code, it's a bug. Issue raised: gitlab#270048 | |
gitlab#229007 (closed) | Tooltip migration | Russell | gitlab!45617 (merged) | |
gitlab#228967 (closed) | Tooltip migration | Russell | gitlab!45623 (merged) | |
gitlab#228982 (closed) | Tooltip migration | Russell | gitlab!46102 (merged) | |
gitlab#219831 (closed) | GlDeprecatedButton to GlButton | Amy | gitlab!38643 (merged) | |
gitlab#219793 (closed) | GlDeprecatedButton to GlButton | Amy | Done independently by dev. | |
gitlab#233601 (closed) | GlDeprecatedDropdown with GlDropdown | Amy | Done independently by dev. | |
gitlab#219860 (closed) | GlDeprecatedButton to GlButton | Amy & Marcel | gitlab!43337 (merged) | |
gitlab#228998 (closed) | vue_shared tooltip with GitLab UI’s tooltip | Amy | gitlab!45446 (merged) | |
gitlab#228999 (closed) | vue_shared tooltip with GitLab UI’s tooltip | Amy | gitlab!45449 (merged) | |
gitlab#228975 (closed) | vue_shared tooltip with GitLab UI’s tooltip | Amy | gitlab!45841 (merged) | |
gitlab#229698 (closed) | deprecatedModal2 to GlModal | Amy | Work already done as part of gitlab!44495 (merged) | |
gitlab#228995 (closed) | Replace vue_shared tooltip | Amy | gitlab!45936 (merged) | |
gitlab#229701 (closed) | deprecatedModal2 to GlModal | Amy | gitlab!46157 (merged) | |
gitlab#229704 (closed) | deprecatedModal2 to GlModal | Amy | gitlab!46183 (merged) | |
gitlab#229694 (closed) | deprecatedModal2 to GlModal | Amy | ||
gitlab#219810 (closed) | GlDeprecatedButton to GlButton | Craig | gitlab!43327 (merged) | |
gitlab#219839 (closed) | GlDeprecatedButton to GlButton | Axil | Done independently by dev. | |
gitlab#219833 (closed) | GlDeprecatedButton to GlButton | Axil | Done independently by dev. | |
gitlab#219826 (closed) | GlDeprecatedButton to GlButton | Mike J | gitlab!40168 (merged) | |
gitlab#229292 (closed) | Bootstrap to GlButton | Mike J | All work repeated independently by dev. | |
gitlab#219807 (closed) | GlDeprecatedButton to GlButton | Mike J | gitlab!43316 (merged) | |
gitlab#235379 (closed) | Bootstrap dropdown to GitLab UI GlDropdown | Mike J | More extensive changes required | |
gitlab#229707 (closed) | Migrate deprecated modal to GlModal | Mike J | Work complete in a different issue, gitlab#229674 (closed) | |
gitlab#219790 (closed) | GlDeprecatedButton to GlButton | Marcia | gitlab!43717 (merged) | |
gitlab#219777 (closed) | GlDeprecatedButton to GlButton | Marcia | gitlab!43714 (merged) | |
gitlab#219808 (closed) | GlDeprecatedButton to GlButton | Marcia | gitlab!43720 (merged) | |
gitlab#219815 (closed) | GlDeprecatedButton to GlButton | Suzanne | gitlab!39515 (merged) | |
gitlab#219814 (closed) | GlDeprecatedButton to GlButton | Suzanne | gitlab!38836 (merged) | |
gitlab#219784 (closed) | GlDeprecatedButton to GlButton | Suzanne | gitlab!39393 (merged) | |
gitlab#219802 (closed) | GlDeprecatedButton to GlButton | Suzanne | gitlab!38753 (merged) | |
gitlab#219799 (closed) | GlDeprecatedButton to GlButton | Suzanne | Duplicate issue. | |
gitlab#229299 (closed) | Bootstrap button to GlButton | Suzanne | Code removed altogether. | |
gitlab#235360 (closed) | Bootstrap dropdown to GitLab UI GlDropdown | Suzanne | Code removed altogether. | |
gitlab#229314 (closed) | Bootstrap button to GlButton | Suzanne | gitlab!42626 (merged) | |
gitlab#235377 (closed) | Bootstrap dropdown to GlDropdown | Suzanne | gitlab!43358 (closed) | |
gitlab#229002 (closed) | Tooltip migration | Suzanne | gitlab!44661 (merged) | |
gitlab#228973 (closed) | Tooltip migration | Suzanne | gitlab!44664 (merged) | |
gitlab#228978 (closed) | Tooltip migration | Suzanne | gitlab!44660 (merged) | |
gitlab#228980 (closed) | Tooltip migration | Nick | Previously fixed in gitlab!44982 (merged) | |
gitlab#228974 (closed) | Tooltip migration | Marcia | gitlab!46034 (merged) | |
gitlab#228990 (closed) | Tooltip migration | Marcia | gitlab!46148 (merged) | |
gitlab#229009 (closed) | Tooltip migration | Marcia | Seems to have been done already. | |
gitlab#229017 (closed) | Tooltip migration | Marcia | gitlab!46156 (merged) | |
gitlab#229022 (closed) | Tooltip migration | Nick | gitlab!46069 (merged) | |
gitlab#229019 (closed) | Tooltip migration | Marcia | gitlab!46171 (merged) | |
gitlab#229702 (closed) | Modal migration | Marcia | TBA |
For the Status column, use
Edited by Craig Norris