[docs] Website build fails on Windows: version-replace plugin doesn't substitute placeholders
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 84/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- javascript
- Domain
- build-system, documentation
Research direction
Start with website/src/plugins/remark-version-replace/index.js and inspect getDocsVersionName(), then reproduce the issue from website/ with npm run clear && npm run build on Windows. Verify that placeholders in iceberg.md, lance.md, and paimon.md are replaced and the broken-links check completes without the reported failures.
Written by the indexing model from the issue text.
Description
Search before asking
- I searched in the issues and found nothing similar.
Description
On Windows, building the documentation website (npm run build in website/) fails the broken-links check. The remark-version-replace plugin does not substitute the $FLUSS_VERSION$ / $FLUSS_MAVEN_REPO_URL$ placeholders, so the Maven-JAR links in iceberg.md, lance.md and paimon.md resolve to a literal $FLUSS_MAVEN_REPO_URL$/... and Docusaurus reports ~24 broken links (onBrokenLinks: 'throw'), failing the build.
Root cause: getDocsVersionName() in website/src/plugins/remark-version-replace/index.js splits the file path on '/' only:
const parts = pathname.split('/');
const websiteIndex = parts.lastIndexOf('website');
On Windows vfile.path uses backslash separators (e.g. C:\...\website\docs\engine-flink\reads.md), so split('/') yields a single-element array, lastIndexOf('website') returns -1, the function returns '', and no replacements are applied.
Steps to reproduce
On Windows, in website/:
npm run clear && npm run build
→ build fails with ~24 broken links pointing to $FLUSS_MAVEN_REPO_URL$/....
Willingness to contribute
- I'm willing to submit a PR!
- Dominant language
- Java
- Stars
- 2.2k
- Forks
- 628
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 138
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from apache/fluss
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
infinispan/infinispan#18150 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
opensearch-project/k-NN#3597 ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100