Commit acb8f390 authored by Amy Qualls's avatar Amy Qualls

Clarify that reference-style links aren't ok

While we had the facts right here, we need to say the phrase
"reference-style" to help users understand this type of link is not
okay.
parent f5952c10
......@@ -320,7 +320,7 @@ create an issue or an MR to propose a change to the user interface text.
- *Feature names are typically lowercase*.
- *Some features are capitalized*, typically nouns naming GitLab-specific
capabilities or tools.
See the [word list](word_list.md) for details.
If the term is not in the word list, ask a GitLab Technical Writer for advice.
......@@ -839,7 +839,7 @@ We include guidance for links in these categories:
### Basic link criteria
- Use inline link Markdown markup `[Text](https://example.com)`.
It's easier to read, review, and maintain. _Do not_ use `[Text][identifier]`.
It's easier to read, review, and maintain. _Do not_ use `[Text][identifier]` reference-style links.
- Use [meaningful anchor texts](https://www.futurehosting.com/blog/links-should-have-meaningful-anchor-text-heres-why/).
For example, instead of writing something like `Read more about GitLab Issue Boards [here](LINK)`,
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment