4 Commits

Author SHA1 Message Date
Arseniy Zaostrovnykh
543d93befd
Fix the rule-id link format (#2408)
Rule IDs are [automatically
transformed](https://github.com/SonarSource/sonar-rule-api/blob/master/src/main/java/com/sonarsource/ruleapi/asciidoctor/AsciiDoctorConverter.java#L111)
into link placeholders by rule-api. These placeholders are translated
into autolinks by the products.
If these IDs appear within other links, it might [break some
products](https://discuss.sonarsource.com/t/cross-rule-references-inside-a-tags-in-html-rule-descriptions/14971/4).

Moreover, the generated autolinks are product-specific, and cannot be
encoded statically in the rule description.
2023-07-05 14:30:33 +00:00
John-Clifton-SonarSource
0aa6cea0ff
Update link_formatting.adoc (#2362)
Added in CWE as pre-defined link.

## Review

A dedicated reviewer checked the rule description successfully for:

- [ ] logical errors and incorrect information
- [ ] information gaps and missing content
- [ ] text style and tone
- [ ] PR summary and labels follow [the
guidelines](https://github.com/SonarSource/rspec/#to-modify-an-existing-rule)
2023-07-03 16:05:22 +01:00
John-Clifton-SonarSource
13b37adc81
Update link_formatting.adoc (#2341)
Fixed rule link example so that rule number was also part of the
underlined link.

## Review

A dedicated reviewer checked the rule description successfully for:

- [ ] logical errors and incorrect information
- [ ] information gaps and missing content
- [ ] text style and tone
- [ ] PR summary and labels follow [the
guidelines](https://github.com/SonarSource/rspec/#to-modify-an-existing-rule)
2023-07-03 10:38:22 +01:00
John-Clifton-SonarSource
55e9cb9961
Create link formatting.adoc (#2324)
Added in formatting guidance for links that appear in rules.

## Review

A dedicated reviewer checked the rule description successfully for:

- [x] logical errors and incorrect information
- [x] information gaps and missing content
- [x] text style and tone
- [x] PR summary and labels follow [the
guidelines](https://github.com/SonarSource/rspec/#to-modify-an-existing-rule)

---------

Co-authored-by: Martin Strecker <103252490+martin-strecker-sonarsource@users.noreply.github.com>
2023-06-29 14:04:43 +01:00