Skip to content

fix: add :orphan: and :nosearch: to included-only RST files#9048

Open
rafaumeu wants to merge 1 commit into
mattermost:masterfrom
rafaumeu:fix/orphan-included-pages-7072
Open

fix: add :orphan: and :nosearch: to included-only RST files#9048
rafaumeu wants to merge 1 commit into
mattermost:masterfrom
rafaumeu:fix/orphan-included-pages-7072

Conversation

@rafaumeu

Copy link
Copy Markdown

Summary

Included-only RST files (files designed to be reused across multiple pages via .. include::) that lack the :orphan: directive display <no title> in the browser tab when accessed directly via URL, and appear incorrectly in site search results.

Fixes #7072

Problem

The file source/product-overview/common-esr-support-rst.rst is included by multiple pages:

  • releases-lifecycle.rst
  • version-archive.rst

But it was missing the :orphan: and :nosearch: metadata that other included-only files already have (e.g., cloud-supported-integrations.rst, all badge files in _static/badges/).

Fix

Added :orphan: and :nosearch: directives to common-esr-support-rst.rst, consistent with the pattern already used across all other included-only files in the docs.

I also did a comprehensive audit of all files referenced by .. include:: directives across the source tree -- this was the only file missing these directives.

Test plan

  • Build the docs with make html
  • Verify common-esr-support-rst.rst no longer appears in search results
  • Verify it no longer shows <no title> when accessed directly

…st#7072)

The file common-esr-support-rst.rst is designed to be included by
multiple pages (releases-lifecycle.rst, version-archive.rst) but
lacks the :orphan: and :nosearch: metadata. When accessed directly
via URL, it displays '<no title>' in the browser tab and appears in
site search results.

Add :orphan: and :nosearch: directives to prevent it from being
indexed or showing up in search, consistent with other included-only
files like cloud-supported-integrations.rst and badge files.
@mattermost-build

Copy link
Copy Markdown
Contributor

Hello @rafaumeu,

Thanks for your pull request! A Core Committer will review your pull request soon. For code contributions, you can learn more about the review process here.

@coderabbitai

coderabbitai Bot commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

@rafaumeu, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 8 minutes and 6 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 88a6059f-064c-4d8b-9025-623303da5eff

📥 Commits

Reviewing files that changed from the base of the PR and between 940b724 and 6476c31.

📒 Files selected for processing (1)
  • source/product-overview/common-esr-support-rst.rst
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Help Wanted: Included pages without headers display <no title> in browser tab

2 participants