docs: update all stale doc references after the docs/ restructure - #5392
Merged
Conversation
Follow-up to apache#5390/apache#5391 sweeping every place outside docs/ that still referenced the old flat doc names: - README.zh-CN.md: capability table + doc nav rewritten to the new quickstart/feature/architecture layout (mirrors the EN README map) - CONTRIBUTING.md: arch-guard and storage-SPI matrix links - docker/Dockerfile: deployment-mode note -> docs/feature/deployment.md - eventmesh.properties (+dist copy): Connector Runtime section comment -> docs/feature/deployment.md - DistributionMode javadoc -> docs/architecture/redesign.md - sdk-java build.gradle OMA comment -> docs/feature/protocols.md - sdk legacy-README.md links - docs/**: link display text and prose mentions still naming old files (evidence.md, production-ha-plan.md, overview.md, client-java.md, protocols.md, control-plane.md, a2a-readiness.md, architecture-guard.md) Repo-wide scan now finds zero stale references (the only remaining docs/reference/ strings are opentelemetry.io spec URLs, untouched). All 227 internal .md links across docs/ + READMEs + CONTRIBUTING resolve. Touched modules compile and pass checkstyleMain.
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
1 participant
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.
Follow-up to #5390 / #5391 — sweep every stale doc reference outside
docs/.Motivation
The docs restructure renamed/moved every page, but ~80 places across READMEs, CONTRIBUTING, code comments, build files, and config templates still referenced the old flat names (
docs/eventmesh-*.md,docs/control-plane.md, …). This PR updates them all.Changes
README.zh-CN.mdquickstart/feature/architecturelayout (mirrors the EN README map)CONTRIBUTING.mddocker/Dockerfiledocs/feature/deployment.mdeventmesh.properties(runtime conf)docs/feature/deployment.mdDistributionMode.javajavadocdocs/architecture/redesign.mdeventmesh-sdk-java/build.gradledocs/feature/protocols.mdlegacy-README.mddocs/**(8 pages)evidence.md,production-ha-plan.md(design records referencing what to update),client-java.md,protocols.md,control-plane.mdVerification
docs/reference/strings left areopentelemetry.iospec URLs — external, untouched)..mdlinks acrossdocs/+ both READMEs + CONTRIBUTING all resolve (0 broken).checkstyleMain(runtime, sdk-java, common).