Repository navigation
docs(runtime): fix the dead Docker installation links in the SDK guides - #3919
Merged
Merged
Conversation
The runtime SDK guides send readers without Docker to modelscope.github.io/FunASR/installation.html#docker, which now returns 404. Point the English guides at docs/installation/docker.md and the Chinese guides at docs/installation/docker_zh.md.
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.
Summary
The runtime SDK deployment guides (offline, offline GPU, offline English and online; English and Chinese versions, 8 files in
runtime/docs/) all tell readers who do not have Docker yet to followhttps://modelscope.github.io/FunASR/installation.html#docker. That page now returns 404, so the first setup step of these guides leads nowhere.The Docker setup instructions now live in
docs/installation/docker.md(English) anddocs/installation/docker_zh.md(Chinese). This PR points the English guides at the English page and the*_zh.mdguides at the Chinese page, using the GitHub URLs of those files. Only that one line changes in each guide.Type of change
Validation
Links checked with
curl -sI(no redirects followed): the old URL returns 404, both new URLs return 200. No code changed, socompilealland runtime commands are not applicable.python -m compileall funasr examples testsUser impact
Production deployers following the runtime SDK guides get a working link to the Docker setup page instead of a 404.
Notes for reviewers
If you would rather link to the website page (for example
https://www.funasr.com/en/docs/docker.html), I can switch the URLs. This was found and link-checked with the help of an AI assistant.