Repository navigation
docs: move Self-hosted steps off Cloud pages into the Self-hosted section [OD-1044] - #2802
Open
claudiacodacy wants to merge 1 commit into
Open
claudiacodacy wants to merge 1 commit into
claudiacodacy wants to merge 1 commit into
Conversation
…tion [OD-1044]
Cloud pages now describe Codacy Cloud only. Each Self-hosted note goes where the norm in
.claude/reference/information-architecture.md puts it, by how much the Cloud steps change:
- Same steps, different inputs (Coverage Reporter, client-side tools, Codacy API, submodules,
duplication reset, seat usage): one section each on the new page "Using Codacy tools with
Codacy Self-hosted", linking to the Cloud procedure.
- Steps that differ: "Managing branches" gets its own Self-hosted page; the
{% if extra.self_hosted %} branch is gone from the Cloud page.
- A Helm value: the 150 KB file limit moves to chart/configuration/file-size-limit.md,
with version tabs.
- The Analysis CLI page keeps its proxy section under "Network" (old anchor pinned); its
Self-hosted lines, and the running-ESLint note, are for @codacy/analysis-cli, which isn't
confirmed on Self-hosted. Kept as a TODO on the new page.
- CLAUDE.md, the docs-edit skill, and repo-map.md point to the norm and the version data
instead of extra.codacy_self_hosted_version.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
|
Overall readability score: 54.41 (🔴 -0.03)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
Contributor
Up to standards ✅🟢 Issues
|
![codacy-production[bot]](https://avatars.githubusercontent.com/in/56611?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Pull Request Overview
An existing deep-link anchor now lands on generic content instead of the Self-hosted instructions previously associated with it. This can leave bookmarked or externally referenced documentation links without the expected guidance and should be addressed before merging.
Test suggestions
- Build the documentation with strict validation and verify all changed links, images, anchors, and navigation entries.
- Verify Cloud pages no longer contain Self-hosted-specific instructions or conditional branches.
- Verify the shared Self-hosted delta page renders version-specific tool and Helm instructions for every supported Self-hosted version.
- Verify the moved branch-management, file-size-limit, API, submodule, duplication, and seat-usage instructions are reachable from the Self-hosted section.
- Verify previously valid anchors are preserved or intentionally retired without broken internal links.
Prompt proposal for missing tests
Consider implementing these tests if applicable:
1. Build the documentation with strict validation and verify all changed links, images, anchors, and navigation entries.
2. Verify Cloud pages no longer contain Self-hosted-specific instructions or conditional branches.
3. Verify the shared Self-hosted delta page renders version-specific tool and Helm instructions for every supported Self-hosted version.
4. Verify the moved branch-management, file-size-limit, API, submodule, duplication, and seat-usage instructions are reachable from the Self-hosted section.
5. Verify previously valid anchors are preserved or intentionally retired without broken internal links.
TIP How was this review? Give us feedback
| export CODACY_API_BASE_URL=<your Codacy instance API URL> | ||
| export CODACY_RESULTS_API_BASE_URL=<your Codacy instance results API URL> | ||
| ``` | ||
| ## Network {: id="network-and-codacy-self-hosted"} |
Contributor
There was a problem hiding this comment.
🟡 MEDIUM RISK
Add a compatibility note at this anchor linking to the new Self-hosted page, or otherwise preserve the Self-hosted guidance here while directing readers to its new location.
TIP React 👍 if this review is right, or reply with what's wrong and how it could be better to help improve the reviewer.
|
|
||
| # Using Codacy tools with Codacy Self-hosted | ||
|
|
||
| The pages for Codacy Coverage Reporter, client-side tools, the Codacy API, and submodules describe Codacy Cloud. Their steps also work on Codacy Self-hosted, with the changes on this page: your instance URL instead of `app.codacy.com`, and the tool versions for your Codacy Self-hosted version. |
Contributor
There was a problem hiding this comment.
⚪ LOW RISK
Suggestion: Align the introduction with the additional Self-hosted-specific behavior documented later on the page, or narrow the page to the differences described in the summary.
TIP React 👍 if this review is right, or reply with what's wrong and how it could be better to help improve the reviewer.
This branch was previously deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Stacked on #2800: merge that first, and this PR's base becomes
master.Cloud pages now describe Codacy Cloud only, as the project decided. This PR moves the remaining "If you're using Codacy Self-hosted" notes into the Self-hosted section, and writes down the norm for where each kind goes so the next writer doesn't have to work it out again. Part of OD-1044 ("Move Self-hosted content off Cloud pages").
The norm (
.claude/reference/information-architecture.md)Where a Self-hosted note goes depends on how much the Cloud procedure has to change:
chart/using-codacy/Exception: a product-level support matrix that compares both, such as the supported Git providers FAQ.
CLAUDE.md, thedocs-editskill, andrepo-map.mdnow point to this norm and todata/self-hosted-versions.ymlinstead ofextra.codacy_self_hosted_version.What moved
#coverage-reporter, version tabs#client-side-tools#api#submodules#duplication#seat-usage{% else %}Self-hosted variantchart/using-codacy/managing-branches.mdchart/configuration/file-size-limit.md, version tabsImages that only those notes used moved with them. No page URL changes, so no redirects. Retired anchors:
#what-about-codacy-self-hosted(150 KB FAQ),#automating-user-keys-for-new-repositories(submodules),#if-youre-using-codacy-self-hosted(plan FAQ); nothing in the repo links to them. The Analysis CLI page's#network-and-codacy-self-hostedstays pinned on its "Network" heading.Not moved: the new Analysis CLI
The Codacy Analysis CLI page now documents
@codacy/analysis-cli(Node, #2749). Self-hosted releases pin the oldercodacy/codacy-analysis-cli7.9.5. The new CLI readsCODACY_API_BASE_URLandCODACY_RESULTS_API_BASE_URL(codacy/analysis-cli@e539fa9), but it calls API v3 endpoints that may postdate Self-hosted v10. So its Self-hosted lines (Analysis CLI "Network" section, running ESLint) are removed from the Cloud pages and kept as aTODO: verifyon the delta page. The delta page points Self-hosted readers to the pinned CLI. CLI owners: does@codacy/analysis-cliwork against Self-hosted v10–v17?Verification
mkdocs build --strictpasses.docs/chart/and the release notes, the only page mentioning Self-hosted is the supported-platforms FAQ (the exception above).👀 Live preview
🚧 To do
🤖 Generated with Claude Code