Skip to content

Conversation

@wangxlong
Copy link
Contributor

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:

  • Dependencies (does it add or upgrade a dependency): (no)
  • The public API, i.e., is any changed class annotated with @Public(Evolving): ( no)
  • The serializers: (no / don't know)
  • The runtime per-record code paths (performance sensitive): (no / don't know)
  • Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn/Mesos, ZooKeeper: (no / don't know)
  • The S3 file system connector: ( no / don't know)

Documentation

  • Does this pull request introduce a new feature? ( no)
  • If yes, how is the feature documented? (not applicable / docs / JavaDocs / not documented)

@flinkbot
Copy link
Collaborator

flinkbot commented Oct 8, 2020

Thanks a lot for your contribution to the Apache Flink project. I'm the @flinkbot. I help the community
to review your pull request. We will use this comment to track the progress of the review.

Automated Checks

Last check on commit 4de3c79 (Thu Oct 08 03:28:28 UTC 2020)

Warnings:

  • Invalid pull request title: No valid Jira ID provided

Mention the bot in a comment to re-run the automated checks.

Review Progress

  • ❓ 1. The [description] looks good.
  • ❓ 2. There is [consensus] that the contribution should go into to Flink.
  • ❓ 3. Needs [attention] from.
  • ❓ 4. The change fits into the overall [architecture].
  • ❓ 5. Overall code [quality] is good.

Please see the Pull Request Review Guide for a full explanation of the review process.

Details
The 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 commands
The @flinkbot bot supports the following commands:

  • @flinkbot approve description to approve one or more aspects (aspects: description, consensus, architecture and quality)
  • @flinkbot approve all to approve all aspects
  • @flinkbot approve-until architecture to approve everything until architecture
  • @flinkbot attention @username1 [@username2 ..] to require somebody's attention
  • @flinkbot disapprove architecture to remove an approval you gave earlier

@flinkbot
Copy link
Collaborator

flinkbot commented Oct 8, 2020

CI report:

Bot commands The @flinkbot bot supports the following commands:
  • @flinkbot run travis re-run the last Travis build
  • @flinkbot run azure re-run the last Azure build

@wangxlong
Copy link
Contributor Author

cc @zentol @klion26 in your free time ~

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
Copy link
Member

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)

Copy link
Contributor Author

@wangxlong wangxlong Oct 12, 2020

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.

Copy link
Member

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?

Copy link
Contributor Author

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.

@wangxlong wangxlong closed this Oct 13, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants