Skip to content
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

Merged
merged 4 commits into from
Oct 16, 2024

Conversation

mjac0bs
Copy link
Contributor

@mjac0bs mjac0bs commented Oct 15, 2024

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 🔄

  • Swaps the expired domain docs link for the Markdown cheatsheet with a valid domain
  • Fixed a couple linter warnings

Target release date 🗓️

10/28

Preview 📷

Before After
Screenshot 2024-10-15 at 9 38 53 AM Screenshot 2024-10-15 at 9 38 28 AM
Screenshot 2024-10-15 at 9 39 24 AM Screenshot 2024-10-15 at 9 39 46 AM

How to test 🧪

Reproduction steps

(How to reproduce the issue, if applicable)

  1. browse to https://cloud.linode.com/support/tickets
  2. click Open New Ticket or click on an existing ticket
  3. click Formatting Tips below the description box
  4. click Markdown cheatsheet link

Verification steps

  1. browse to http://localhost:3000/support/tickets
  2. click Open New Ticket or click on an existing ticket
  3. click Formatting Tips below the description box
  4. click Markdown cheatsheet link

As an Author I have considered 🤔

Check all that apply

  • 👀 Doing a self review
  • ❔ Our contribution guidelines
  • 🤏 Splitting feature into small PRs
  • ➕ Adding a changeset
  • 🧪 Providing/Improving test coverage
  • 🔐 Removing all sensitive information from the code and PR description
  • 🚩 Using a feature flag to protect the release
  • 👣 Providing comprehensive reproduction steps
  • 📑 Providing or updating our documentation
  • 🕛 Scheduling a pair reviewing session
  • 📱 Providing mobile support
  • ♿ Providing accessibility support

@mjac0bs mjac0bs self-assigned this Oct 15, 2024
@mjac0bs mjac0bs requested a review from a team as a code owner October 15, 2024 16:48
@mjac0bs mjac0bs requested review from hana-akamai and cpathipa and removed request for a team October 15, 2024 16:48
@mjac0bs mjac0bs changed the title Update docs link to valid domain fix: [M3-8748] - Markdown cheatsheet link in Support ticket interface has an expired domain Oct 15, 2024
Copy link

Coverage Report:
Base Coverage: 86.96%
Current Coverage: 86.96%

Copy link
Contributor

@hana-akamai hana-akamai left a 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 🤔
image

I like https://commonmark.org/help/ better since it feels more like a cheat sheet than https://daringfireball.net/projects/markdown/syntax

Copy link
Contributor

@cpathipa cpathipa left a 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.

@mjac0bs
Copy link
Contributor Author

mjac0bs commented Oct 16, 2024

Huh, seems like the showdown domain is back up again 🤔

😅 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.

@mjac0bs mjac0bs requested a review from hana-akamai October 16, 2024 19:55
Copy link
Contributor

@hana-akamai hana-akamai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹

@hana-akamai hana-akamai added Approved Multiple approvals and ready to merge! and removed Ready for Review labels Oct 16, 2024
@mjac0bs mjac0bs merged commit 98a260c into linode:develop Oct 16, 2024
21 of 23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved Multiple approvals and ready to merge!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants