-
Notifications
You must be signed in to change notification settings - Fork 13.8k
[Hotfix][Docs] Fix broken link of flink-architecture.md #13559
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Hotfix][Docs] Fix broken link of flink-architecture.md #13559
Conversation
|
Thanks a lot for your contribution to the Apache Flink project. I'm the @flinkbot. I help the community Automated ChecksLast check on commit 4de3c79 (Thu Oct 08 03:28:28 UTC 2020) Warnings:
Mention the bot in a comment to re-run the automated checks. Review Progress
Please see the Pull Request Review Guide for a full explanation of the review process. DetailsThe Bot is tracking the review progress through labels. Labels are applied according to the order of the review items. For consensus, approval by a Flink committer of PMC member is required Bot commandsThe @flinkbot bot supports the following commands:
|
| local JVM (``LocalEnvironment``) or on a remote setup of clusters with multiple | ||
| machines (``RemoteEnvironment``). For each program, the | ||
| [``ExecutionEnvironment``]({{ site.baseurl }}/api/java/) provides methods to | ||
| [``ExecutionEnvironment``]({{ site.javadocs_baseurl }}/api/java/) provides methods to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why do we need to change this?
Seems the link is correct and reachable. (test use documentation of 1.11)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's kind of weird. I run build_docs.sh shell, and when I clicked this link in my local browser, it can not reachable. This is a javadocs url not other document, So I change this, and it is ok in my local. I checked the master and 1.11 just now, yes, it is reachable.
I run the check_links.sh just now, it also showed that ERROR /api/java/ not found.
BTW, there are other links broken by running check_links.sh shell.
1./api/java/org/apache/flink/types/RowKind.html' not found.
2./dev/python/table-api-users-guide/udfs.html
3. /dev/python/user-guide/table/dependency_management.html
For the first, I checked it, it is the same with this.
For the second, I did not found any documents use this url.
For the third, Maybe it is really broken. We should use dev/python/table-apis-users-guide/dependency_management.html not dev/python/user-guide/table/dependency_management.html.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@wangxlong I'm not very sure why the java doc links broken locally. maybe you need to generate the java doc locally before reaching to the doc.
Thanks for checking the broken links. Could you please file an issue to fix the other broken links you mentioned?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I close this pr, and open a issue to fix these.
What is the purpose of the change
Fix broken link of flink-architecture.md
Brief change log
Fix broken link of flink-architecture.md
Verifying this change
This change is a trivial rework / code cleanup without any test coverage.
Does this pull request potentially affect one of the following parts:
@Public(Evolving): ( no)Documentation