Strikethrough is ~~not~~ supported in titles
Description
- Allow the issue title to support all GFM.
- We shouldn't be overly restrictive about a text field.
- It is up to the users to be intelligent and use the issue title responsibly. We should let them do so.
Original description
See above, not should be strikethrough but it is not. The weird thing is in the change history it partially shows that way.
Activity
added bug label
@joshlambert : The title should be a GFM-compatible field. (As you see, you can put emoji in it.)
@victorwu
double tildeis GFM though right?@joshlambert: Yes, it appears so: https://docs.gitlab.com/ee/user/markdown.html#emphasis.
I was saying that this is the intended design (and thus this is a valid bug).
Just checked the handbook again. Markdown is Discussion.
changed milestone to %10.1
@smcgivern : Is there some BE work here?
@victorwu I'd say it's Discussion (as currently labeled) since it's about issue titles.
Edit: Ah, I see you already found this :)
Note that the title field supports some GFM (like references and emoji), but not any Markdown styling. The pipeline it runs through is https://gitlab.com/gitlab-org/gitlab-ce/blob/master/lib/banzai/pipeline/single_line_pipeline.rb#L6.
Edited by Douwe Maan@victorwu yes, this is entirely backend, but I'm not sure why we'd expect it to work - we don't support headers, bold, italics, etc. in issue titles either, as Douwe says
🙂 added UX feature proposal and removed bug labels
changed milestone to %10.2
Thanks @DouweM @smcgivern . Then it's a feature request! At least for me.
We don't want to overly restrict users when they are using GitLab. We should trust that they are using it responsibly, and not try to capture every single edge case and let them use the tool as they see fit. This means for fields like issue title, we should give some flexibility.
The reverse argument is that the title field is semantically just that, a title. It is not a place to do styling. So if we open the floodgates for users to start putting a lot of styling there, they may take it too far, start abusing the flexibility, and soon users may be asking for features / fixes that don't make sense, for example, when their super styled issue title looks bad in an issue board card.
@smcgivern : From a technical perspective, what's simpler to maintain? (And thus overall the product is simpler to maintain, reduces risk, etc.) I would assume if the issue title is not a special case, it makes the code cleaner?
Thoughts?
@victorwu from a technical perspective, it's simpler to leave it like it is
🙂 Which markdown features would we want to allow in titles? Obviously not any block-level elements (headers, lists, quotes, etc.). What about bold and italic? Links seem like a bad idea, too.
@smcgivern : I think it's better to go fully in one way or another way. Wouldn't that be simpler to maintain? I think that's easier to communicate/document and just set expectations for users. So we can simply say, you can only enter plain text, and whatever you enter, it will be rendered exactly that way.
@victorwu I'm happy with that as it goes, but putting a link in an issue title is weird, because in many contexts, the title itself is a link. Maybe we just say this isn't supported for now?
😃 @victorwu If "all in" means supporting block level elements in titles, I think we should definitely go all out.
Note that it's not unprecedented to support only a subset of Markdown in some places. We already do in project descriptions, for example.
mentioned in issue #36069
Back to the original issue that @joshlambert pointed out. The system note is rendering the strikethrough, but the title is not. So with whatever decide, I guess we should be consistent?
mentioned in issue victorwu/hello-world3#2
Starting digging into this and went down a rabbit hole, i.e.: https://gitlab.com/gitlab-org/gitlab-ce/issues/36999.
Thinking this further through, it seems like it makes sense to have the title render:
- Emoji, because they are fun, and it's 2017.
- Internal links/styling to GitLab objects, so basically everything in https://gitlab.com/gitlab-org/gitlab-ce/issues/36999.
- Bold/italic/strike.
I think it's reasonable to render bold/italic/strike. But nothing beyond that for text styling. No subscript/superscript. No colors. No LaTeX. These would be helpful, but users wouldn't have the power totally abuse the field.
It should not render things like email addresses as mailto links, and generic URLs as web links.
Seems like most of that is already existing, as @DouweM pointed to here: https://gitlab.com/gitlab-org/gitlab-ce/blob/master/lib/banzai/pipeline/single_line_pipeline.rb#L6.
Thoughts?
I think it's reasonable to render bold/italic/strike.
The title is bold by default. I don't see any valid reasoning for allowing italicized text and strikethrough.
All the rest sounds fine to me @victorwu.
@victorwu I think what we have right now is pretty good, unless we have a strong reason to change it. Implementing 'partial Markdown' is possible, but I don't know if that strong reason really exists.
@victorwu I don't see how bold/italics/strikethrough make a title more useful. Emoji and references, we already support.
Thanks @DouweM @smcgivern : Take a look at
So the only proposed change is:
- Make labels displayed as labels, i.e.
~bugwould be rendered as bug
- Make labels displayed as labels, i.e.
@victorwu Private project! I can't see those issues.
Sorry @DouweM . Try again.
@victorwu I think it will be very confusing on issues indexes like https://gitlab.com/gitlab-org/gitlab-ce/issues if we have labels in the title and in the row below it. It will not be clear which are actually lavels on the issue, and which are simply part of the title.
@DouweM : Makes sense. I don't think there's anything actionable here then. Thank you for your patience.
