Skip to content

docs: add Self-hosted deprecation notice to chart pages [OD-245] - #2784

Merged
claudiacodacy merged 5 commits into
masterfrom
docs-self-hosted-deprecation-banner-od-245
Oct 19, 2026
Merged

claudiacodacy merged 5 commits into
masterfrom
docs-self-hosted-deprecation-banner-od-245

Conversation

@claudiacodacy

@claudiacodacy claudiacodacy commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

Adds a notice at the top of every /chart/ page saying Codacy Self-hosted is no longer available for new customers, with a "Talk to us" link (the start-chat link the docs use for upgrade prompts) for readers with specific requirements. Requested in OD-245.

What changed

  • theme/partials/notices.html: new notice shown when page.url starts with chart/. These pages come from the codacy/chart submodule, so the theme renders the notice and the chart repo doesn't change. The notice reuses the existing docs-notice style, which already supports both color schemes.

Not covered

  • The versioned Self-hosted sites (/v14.0/ and older) are built from release/v* branches, which use the old codacy-mkdocs-material theme. They keep their existing "This documentation applies to Codacy Self-hosted" notice. Changing that copy would mean updating that repo and redeploying each release branch. Those builds already send noindex.
  • The notice is skipped on builds with MKDOCS_SELF_HOSTED set, since those builds already show a Self-hosted notice.

Checks

  • mkdocs build --strict passes.
  • The notice appears on all 22 real pages under site/chart/ and on no other page. The 23rd file there is a redirect stub.
  • Looked at /chart/ and /chart/maintenance/upgrade/ at desktop width in light and dark mode, and at 375 px wide in light mode.

👀 Live preview

🚧 To do

  • If relevant, include the Jira issue key at the end of the pull request title
  • Perform a self-review of the changes
  • Fix any issues reported by the CI/CD

🤖 Generated with Claude Code

The chart pages come from the codacy/chart submodule, so the notice is
rendered by the theme for any page under chart/ instead of being added
to that repo.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@claudiacodacy
claudiacodacy requested a review from a team as a code owner October 19, 2026 15:45
@codacy-production

Copy link
Copy Markdown
Contributor

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

AI Reviewer: first review requested successfully. AI can make mistakes. Always validate suggestions.

Run reviewer

TIP This summary will be updated as you push new changes.

@codacy-production codacy-production Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

✅ No blocking issues noticed

No blocking findings were identified. No acceptance-criteria gaps were reported by the review agents.

Test suggestions

  • Render a chart page in a non-Self-hosted build and verify the deprecation notice and Quickstart link are present.
  • Render a chart page in a Self-hosted build and verify the deprecation notice is absent.
  • Render a non-chart page and verify the new notice is absent.
Prompt proposal for missing tests
Consider implementing these tests if applicable:
1. Render a chart page in a non-Self-hosted build and verify the deprecation notice and Quickstart link are present.
2. Render a chart page in a Self-hosted build and verify the deprecation notice is absent.
3. Render a non-chart page and verify the new notice is absent.

TIP Improve review quality by adding custom instructions
TIP How was this review? Give us feedback

@github-actions
github-actions Bot temporarily deployed to Netlify October 19, 2026 15:46 Inactive
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions
github-actions Bot temporarily deployed to Netlify October 19, 2026 15:53 Inactive
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions
github-actions Bot temporarily deployed to Netlify October 19, 2026 15:55 Inactive
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@claudiacodacy
claudiacodacy enabled auto-merge (squash) October 19, 2026 16:03
@claudiacodacy
claudiacodacy merged commit bf04941 into master Oct 19, 2026
5 checks passed
@claudiacodacy
claudiacodacy deleted the docs-self-hosted-deprecation-banner-od-245 branch October 19, 2026 16:27

This branch was successfully deployed

1 active deployment
Netlify — 26caf3ce Deployed Oct 19, 2026 by github-actions[bot]
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