Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/-/merge_requests/1094 below:

Cards: add description text for external URLs (!1094) · Merge requests · GitLab.org / Technical Writing

WHAT

• This MR allows tech writers to add a description when mentioning external links in cards shortcode.
• Allows for double and single quotes and also allows empty description.

WHY

• Typically, we grab descriptions from the markdown files using frontmatter but in the case where we use external links we can't grab descriptions. Therefore we need to allow tech writers to add a simple description when mentioning external links.

Numbered steps to set up and validate the change are strongly suggested.

1. Configure a local GitLab Docs environment.
2. Check out this branch.
3. On local, turn off draft mode for shortcode-tests.md (i.e. draft: false) and check http://localhost:1313/shortcode-tests/#cards-with-external-link-and-description-single-quotes and http://localhost:1313/shortcode-tests/#cards-with-external-link-and-description-double-quotes

NOTE: No changes expected to normal markdown related cards, only affects external links.

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

• I have evaluated the MR acceptance checklist for this merge request.

Closes #408

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4