-
Notifications
You must be signed in to change notification settings - Fork 364
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix: [M3-8748] - Markdown cheatsheet link in Support ticket interface has an expired domain #11101
fix: [M3-8748] - Markdown cheatsheet link in Support ticket interface has an expired domain #11101
Conversation
Coverage Report: ✅ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Huh, seems like the showdown domain is back up again 🤔
I like https://commonmark.org/help/ better since it feels more like a cheat sheet than https://daringfireball.net/projects/markdown/syntax
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like CommonMark
is widely used in projects like GitHub and Reddit etc, I don't have strong opinion as longs as we have a reliable Markdown tool.
😅 So it is! It sounds like we've got consensus that CommonMark is a good link. I'm going to go ahead and swap showdown out with CommonMark in this PR. I think one person maintains showdown and could let the domain expire again a year from now. CommonMark, as a project maintained by multiple people to implement Markdown standards, seems less likely to leave us with an expired domain. Update: Jacob (from Support) pointed out this comment. Further evidence that moving away from showdown is probably for the best. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧹
Description 📝
When opening or replying to a Support ticket in Cloud Manager, the Formatting Tips expansion section currently has the following text:
You can use Markdown to format your reply. For more examples see this Markdown cheatsheet
The domain demo.showdownjs.com has expired, currently showing:
Este domínio expirou.
which translates to:
This domain has expired.
We should link customers to a well-reputed, valid domain.
Note
Support has suggested https://daringfireball.net/projects/markdown/syntax because this is the website of John Gruber, the creator of Markdown. Support also noted that the presentation of information wasn't the best. I considered linking to the CommonMark help instead and am open to team's feedback and preference.
Changes 🔄
Target release date 🗓️
10/28
Preview 📷
How to test 🧪
Reproduction steps
(How to reproduce the issue, if applicable)
Verification steps
As an Author I have considered 🤔
Check all that apply