Skip to content

Clarify when to use external links - #598

Merged
IngridT1 merged 1 commit into
redhat-documentation:mainfrom
lburcher7:update-external-links-guidance
Sep 16, 2026
Merged

IngridT1 merged 1 commit into
redhat-documentation:mainfrom
lburcher7:update-external-links-guidance

Conversation

@lburcher7

Copy link
Copy Markdown
Contributor

Consolidated the rationale for minimizing external links and added guidance on when external links are appropriate (deployment, configuration, or integration with supported partner platforms).

Issue: #492

Consolidate the rationale for minimizing external links and add guidance
on when external links are appropriate (deployment, configuration, or
integration with supported partner platforms).

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Sep 16, 2026 •

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: eb03a241-825f-4a8f-bf35-42ea218478a9

📥 Commits

Reviewing files that changed from the base of the PR and between 30689e3 and 33c9bb0.

📒 Files selected for processing (1)
  • supplementary_style_guide/style_guidelines/links.adoc

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated the style guide’s external-link guidance to recommend minimizing links to external sites.
    • Clarified that external links should be used only when necessary for product deployment, configuration, or integration.
    • Added official partner platform documentation, such as AWS, Azure, and Google Cloud Platform, as an example of appropriate external references.

Walkthrough

The external links guidance now minimizes links to sites outside Red Hat or IBM. It also permits external links when they are necessary for deployment, configuration, or integration.

Changes

External Link Guidance

Layer / File(s) Summary
External link guidance update
supplementary_style_guide/style_guidelines/links.adoc
The first guideline was reworded. A second guideline now limits external links to necessary deployment, configuration, or integration documentation and cites official partner platforms as examples.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 33c9b

This change clarifies when external links are appropriate without establishing a harmful behavior or release risk.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: clarifying when to use external links.
Description check ✅ Passed The description summarizes the changes and includes the related issue link. The optional Additional information section is omitted, but the required information is sufficiently complete.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@IngridT1
IngridT1 merged commit e1580e5 into redhat-documentation:main Sep 16, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants