Draft: Bring parity to RTE & PTE
-
Please check this box if this contribution uses AI-generated content (including content generated by GitLab Duo features) as outlined in the GitLab DCO & CLA. As a benefit of being a GitLab Community Contributor, you receive complimentary access to GitLab Duo.
What does this MR do and why?
Currently the plaintext editor and Rich Text editor toolbars have some dissimilarity, this MR adds:
- A collapsible button addition to RTE, similar to the plain text editor.
- Adds a visual separator between the "Add a quick action" and "Insert comment template" buttons in plain text editor.
Screenshots or screen recordings
Screenshots are required for UI changes, and strongly recommended for all other merge requests.
Before | After |
---|---|
![]() |
![]() |
How to set up and validate locally
Numbered steps to set up and validate the change are strongly suggested.
Related to #507377
Merge request reports
Activity
added devopsplan groupknowledge sectiondev labels
added pipelinetier-1 label
Thanks for your contribution to GitLab @mehulsharma!
Did you know about our community forks? Working from there will make your contribution process easier. Please check it out!
- If you need help, page a coach by clicking here or come say hi on Discord.
- When you're ready, request a review by clicking here.
- We welcome AI-generated contributions and offer complimentary access to GitLab Duo!
- To add labels to your merge request, comment
@gitlab-bot label ~"label1" ~"label2"
.
This message was generated automatically. Improve it or delete it.
added Community contribution workflowin dev labels
assigned to @mehulsharma
added linked-issue label
mentioned in issue #507377
requested review from @himkp
5 Warnings This merge request changed files with disabled eslint rules. Please consider fixing them. This merge request does not refer to an existing milestone. This merge request contains lines with testid selectors. Please ensure e2e:test-on-omnibus
job is run.You've made some app changes, but didn't add any tests.
That's OK as long as you're refactoring existing code,
but please consider adding any of the maintenancepipelines, maintenancerefactor, maintenanceworkflow, maintenanceperformance, documentation, QA labels.This merge request changed undocumented Vue components in
vue_shared/
. Please consider creating Stories for these components:app/assets/javascripts/vue_shared/components/markdown/header.vue
Disabled eslint rules
The following files have disabled
eslint
rules. Please consider fixing them:app/assets/javascripts/vue_shared/components/markdown/header.vue
Run the following command for more details
node_modules/.bin/eslint --report-unused-disable-directives --no-inline-config \ 'app/assets/javascripts/vue_shared/components/markdown/header.vue'
testid
selectorsThe following changed lines in this MR contain
testid
selectors:app/assets/javascripts/content_editor/components/formatting_toolbar.vue
+ data-testid="collapsible-section"
If the
e2e:test-on-omnibus
job in theqa
stage has run automatically, please ensure the tests are passing. If the job has not run, please start themanual:e2e-test-pipeline-generate
job in theprepare
stage and ensure the tests infollow-up:e2e:test-on-omnibus-ee
pipeline are passing.For the list of known failures please refer to the latest pipeline triage issue.
If your changes are under a feature flag, please check our Testing with feature flags documentation for instructions.
Reviewer roulette
Category Reviewer Maintainer frontend @leetickett-gitlab
(UTC+0)
@blabuschagne
(UTC+1)
Please refer to documentation page for guidance on how you can benefit from the Reviewer Roulette, or use the GitLab Review Workload Dashboard to find other available reviewers.
If needed, you can retry the
danger-review
job that generated this comment.Generated by
Dangerrequested review from @digitalmoksha
@mehulsharma this looks good.
Since we're adding the collapsible toolbar button in the RTE, I think we should remove the "Details block" from the dropdown menu at the end of the toolbar.
There probably needs to be some tests added, but I'll let @himkp guide you on where that would need to be added.
Since we're adding the collapsible toolbar button in the RTE, I think we should remove the "Details block" from the dropdown menu at the end of the toolbar.
Makes sense. When I was testing this branch, I wondered if we have a tracker for each of the editor's features that would inform us of usage?
It would be wonderful to have this data at some point so we can start to surface more of the features that people want instead of hiding them inside a dropdown.
FYI @mmacfarlane
Thanks @mmacfarlane I thought I had tableau access but I don't, so I've just opened a access request for that one. Do I need SAFE data access?
@afracazo @mmacfarlane We need to do some modifications to those views to ensure that they are accurate. Can we set up some time, possibly 30 minutes with someone from the data team? I can also do those modifications but I don't have permissions to save.
@himkp Matthew Petersen is our counterpart for this. I looked at Gcal and the four of us don't have overlap that would work. I see a couple options:
- We can detail what modification(s) we would like to see and put in a formal request to Matthew and the data team. This aligns more with the process in the handbook.
- You could find time to chat with Matthew 1:1 and async update Alex and I after. Not as traditional of an approach but probably more straightforward.
Edited by Matthew Macfarlane@mmacfarlane Sounds like a good plan, @himkp I'm normally working in my evenings, so feel free to add me as well in case you organize the meeting in your mornings.
Edited by Alex Fracazo@himkp up to you which way you would like to proceed. I don't believe that should be a blocker to Merging this change, also in your discretion
- We can detail what modification(s) we would like to see and put in a formal request to Matthew and the data team. This aligns more with the process in the handbook.
- You could find time to chat with Matthew 1:1 and async update Alex and I after. Not as traditional of an approach but probably more straightforward.
Since we're adding the collapsible toolbar button in the RTE, I think we should remove the "Details block" from the dropdown menu at the end of the toolbar.
This needs to be addressed and then we can merge it. I'll do this week since I don't think the contributor is available anymore to wrap it up.
Once this is merged, and Support Admonition Boxes in Markdown Rendering ... (!178775 - merged) is merged, we add Alerts to the PTE menu.
added UX label
Thanks for helping us improve the UX of GitLab. Your contribution is appreciated! We have pinged our UX team, so stay tuned for their feedback.
This message was generated automatically. Improve it or delete it.
requested review from @afracazo
added pipeline:mr-approved label
added pipelinetier-3 pipeline:run-e2e-omnibus-once labels and removed pipelinetier-1 label
Before you set this MR to auto-merge
This merge request will progress on pipeline tiers until it reaches the last tier: pipelinetier-3.
Before you set this MR to auto-merge, please check the following:
- You are the last maintainer of this merge request
- The latest pipeline for this merge request is pipelinetier-3 (You can find which tier it is in the pipeline name)
- This pipeline is recent enough (created in the last 8 hours)
If all the criteria above apply, please set auto-merge for this merge request.
See pipeline tiers and merging a merge request for more details.
@mehulsharma Another great MR! Well done! Loving to review your work mate! Approved!
Thanks for working on this@himkp Probably not related to this MR and more related to my local GDK, but want to let you know that when checked the branch and posting comments I was switching back and forth from dark mode, I started to get an error when posting comments:
Your comment could not be submitted! Please check your network connection and try again.
but it did submit my comment.Edited by Alex Fracazomentioned in issue #508543
@mehulsharma, it seems we're waiting on an action from you for approximately two weeks.
- Do you still have capacity to work on this? If not, you might want to close this MR and/or ask someone to take over.
- Do you need help in getting it ready? At any time, you can:
- If you're actually ready for a review, you can post
@gitlab-bot ready
.
This message was generated automatically. You're welcome to improve it.
@himkp is this item in a suitable spot to Merge?
added automation:author-reminded label
removed review request for @himkp
assigned to @himkp
mentioned in merge request !178775 (merged)
Hi @mehulsharma
How was your code review experience with this merge request? Please tell us how we can continue to iterate and improve:
- React with a
or a on this comment to describe your experience. - Create a new comment starting with
@gitlab-bot feedback
below, and leave any additional feedback you have for us in the comment.
Request access to our community forks to receive complimentary access to GitLab Duo, our AI-powered features. With Code Suggestions, Chat, Root Cause Analysis and more AI-powered features, GitLab Duo helps to boost your efficiency and effectiveness by reducing the time required to write and understand code and pipelines. Visit the GitLab Duo documentation to learn more about the benefits.
See where you rank! Check your spot on the contributor leaderboard and unlock rewards.Thanks for your help!
This message was generated automatically. Improve it or delete it.
- React with a