Repository navigation
fix: update stale util/ references - #307
Open
avp9-nexus wants to merge 1 commit into
Open
avp9-nexus wants to merge 1 commit into
avp9-nexus wants to merge 1 commit into
Conversation
The CRS 2.x to 3 upgrade section of the installation guide named util/id_renumbering/update.py and util/id_renumbering/IdNumbering.csv, and the known issues page recommended the util/join-multiline-rules script; none of these paths is in the CRS repository. The installation guide now names both files as shipped with CRS 3.0.0 and links tree/v3.0.0/id_renumbering, with the sentence that coreruleset/coreruleset#4888 puts in INSTALL.md. The "Apache 2.4 prior to 2.4.11" section of the known issues page is removed, as coreruleset/coreruleset#4888 does with the same entry in KNOWN_BUGS.md: the script was removed in coreruleset/coreruleset#3877, and the platforms the entry names are end of life.
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars.
|
This branch has not been 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.
what
Two pages send readers to
util/paths that are not in the CRS repository. This applies to them the fixes that coreruleset/coreruleset#4888 makes toINSTALL.mdandKNOWN_BUGS.mdin that repository.content/1-getting-started/1-1-crs-installation.md, "Upgrading from CRS 2.x to CRS 3": the sentence that namedutil/id_renumbering/update.pyandutil/id_renumbering/IdNumbering.csvnow names the two files as shipped with CRS 3.0.0, with a link totree/v3.0.0/id_renumbering. It is the sentence that docs: fix dead references in rule comments and docs coreruleset#4888 puts inINSTALL.md.content/7-known-issues/_index.md: the "Apache 2.4 prior to 2.4.11" section is removed, as docs: fix dead references in rule comments and docs coreruleset#4888 does with the same entry inKNOWN_BUGS.md. Its workaround script,util/join-multiline-rules, was removed in chore: remove join multiline rules coreruleset#3877, and the platforms it names are end of life.why
CodeRabbit noted on coreruleset/coreruleset#4888 that this repository carries the same two stale references (coreruleset/coreruleset#4888 (comment)), and I said there that I would open a separate pull request. The link check here does not catch them: they are paths in the text, not links.
The new sentence links to the files shipped with 3.0.0 rather than to the table on the rule ID page (
content/3-about-rules/ruleid.md): that page presents it as the mapping to 3.0.0-rc1 IDs, and it differs from the file shipped with 3.0.0 (for example, 981044 maps to 912000 there and to 912120 in 3.0.0).content/3-about-rules/creating.md(lines 268-269), on a page marked as possibly outdated, also tells rule authors to include their sources "within this util directory"; it names no path, so it is left as is here.#222 also rewrites the known issues page and keeps this entry, with new wording that no longer names
util/join-multiline-rules. If you would rather settle that entry there, I will take the known issues change out of this pull request.Checked offline against
main(ee326b0):test.yml, with the same warnings asmain, andenglish_test.shpasses;util/path and everycoreruleset/corerulesetblobortreelink incontent/against the repository tree (atmain, or atv3.0.0for links to that tag) reports the three paths above onmainand nothing on this branch.refs
INSTALL.mdandKNOWN_BUGS.md)util/join-multiline-rules)ai disclosure
tools used: Claude Code (Claude Opus 5.5)
assisted with: checking the two references CodeRabbit flagged and searching
content/for others, the two edits, the checks above, and the text of this descriptionreview performed: Claude Code ran the checks above in an offline sandbox and reverted each edit on its own to confirm that the path check fails without it; I reviewed the diff and this description before opening the pull request.