Skip to content
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

[FLINK-17353][docs] Fix Broken links in Flink docs master #12196

Closed
wants to merge 3 commits into from

Conversation

yangyichao-mango
Copy link
Contributor

@yangyichao-mango yangyichao-mango commented May 17, 2020

What is the purpose of the change

Fix all of the broken links in Flink docs master mentioned in [FLINK-17353]

Brief change log

  • Add flink-architecture.zh.md Chinese documents matching English documents
  • Fix all of the broken links in [FLINK-17353] and redirect those links to the right pages

Does this pull request potentially affect one of the following parts:

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

Documentation

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

@flinkbot
Copy link
Collaborator

flinkbot commented May 17, 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 19f5ffd (Fri Oct 16 10:49:56 UTC 2020)

✅no warnings

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.


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

@yangyichao-mango
Copy link
Contributor Author

cc @wuchong

@@ -0,0 +1,132 @@
---
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This md is added for matching English flink-architecture.md

@flinkbot
Copy link
Collaborator

flinkbot commented May 17, 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

@klion26
Copy link
Member

klion26 commented May 18, 2020

@yangyichao-mango thanks for your contribution. could you please share the result after execute sh docs/check_links.sh here (you have to execute sh docs/build_docs.sh -p before execute the check_links script)

@yangyichao-mango
Copy link
Contributor Author

@klion26 That is the result of spider.log
Find 3 Broken links.

http://localhost:4000/ops/memory/mem_setup_jm.html
http://localhost:4000/zh/ops/memory/mem_detail.html
http://localhost:4000/zh/dev/user_defined_functions.html

But All of this three broken links don't belong to [FLINK-17353].
Do i need to Fix those broken links?

@wuchong
Copy link
Member

wuchong commented May 18, 2020

Hi @yangyichao-mango , please fix them too. This issue is aiming to fix all the broken links to make the CRON build pass.

@yangyichao-mango
Copy link
Contributor Author

yangyichao-mango commented May 19, 2020

That is the result of check_links.sh.
找到 1 个死链接。

http://localhost:4000/zh/ops/memory/mem_detail.html

When I try to fix http://localhost:4000/zh/ops/memory/mem_detail.html, I'm blocked by three mds that are not updated to match English md.

ops/memory/mem_setup_tm.md
ops/memory/mem_trouble.md
ops/memory/mem_migration.md

I think we should create a new jira issue to update those mds. When that new issue is done, I can continue to fix this broken link (http://localhost:4000/zh/ops/memory/mem_detail.html).

cc @wuchong

@wuchong wuchong closed this in 4dc3bda May 19, 2020
@wuchong
Copy link
Member

wuchong commented May 19, 2020

Merged and created an following up issue FLINK-17807 to resolve this broken link.

wuchong pushed a commit that referenced this pull request May 19, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
5 participants