[ENG] Updates to CodeSuggestions component
Goal
We would like to increase support for different typo of content by allowing to input comments inside the highlighted code with the right comment
styling
We would like to improve the overall maintainability of the CodeSuggestions component by reducing the use of regular expressions (regex) in the logic. We would like to use the CODE_HIGHLIGHTING
constants as much as possible to replace the hard coded regex we have right now.
Jobs To Be Done
- Situation: When ... we visit the /solutions/code-suggestions/ page
- Motivation: We want to ... have comments in the highlighted code and less regex used
- Outcome: So we can ... increase support and maintainability
Please provide more information related to this request
Make sure the information you provide is relevant for your request. If unsure, please provide all the fields. Add/remove rows as needed.
If this is urgent, what is the business need for the urgency?
-
Yes: what is the business need for the urgency
-
No
If the requestor is not the DRI, find out if the DRI is aware of the request / wants to change things.
Does anyone in leadership have eyes on this project?
-
Yes @personshandle
-
No
Compliance / legal / accessibility regulations to be aware of?
-
Yes: Please describe why
-
No: Please describe why
What is the ultimate end goal vision vs the MVC1 iteration?
End goal for this MVC iteration is XYZ
How do we measure success?
Please describe how success will be measured
What analytics / data will we need to set-up?
-
Yes: Please describe what analytics will need to be set up
-
No
Page(s)
Which page(s) are involved in this request?
[Code suggestions](https://about.gitlab.com/solutions/code-suggestions)
DCI
-
DRI: @mduque-ext
-
Consulted: @justin.vetter -
Informed: Everyone
In scope
What is within scope of this request?
-
Support for comments in the highlighted code -
More consistent logic for the syntax highlight
Requirements
What are the requirements for this request? Checklist below is an example of common requirements, please check all that apply and adjust as necessary:
-
Copy writing -
Illustration -
Custom Graphics -
Research -
Data / Analytics -
UX Design -
Engineering