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-16210][docs] Extending the "Flink Architecture" section. #12057

Closed
wants to merge 4 commits into from
Closed

[FLINK-16210][docs] Extending the "Flink Architecture" section. #12057

wants to merge 4 commits into from

Conversation

morsapaes
Copy link
Contributor

What is the purpose of the change

This PR extends the "Flink Architecture" section of the docs with more information about Flink Master components and application execution (incl. the new Application Cluster mode).

Brief change log

  • Modified 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
  • The runtime per-record code paths (performance sensitive): no
  • Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn/Mesos, ZooKeeper: no
  • The S3 file system connector: no

Documentation

  • Does this pull request introduce a new feature? no

…rmation about Flink Master components and application execution.
@morsapaes
Copy link
Contributor Author

Pinging @aljoscha and @alpinegizmo (who had this rework in mind as well).

@flinkbot
Copy link
Collaborator

flinkbot commented May 10, 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 41c4429 (Fri Oct 16 10:54:29 UTC 2020)

Warnings:

  • Documentation files were touched, but no .zh.md files: Update Chinese documentation or file Jira ticket.

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

@flinkbot
Copy link
Collaborator

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

@aljoscha aljoscha self-assigned this May 12, 2020
@aljoscha
Copy link
Contributor

Thanks a lot for working on this! I pushed two commits with suggestions.

Another (slightly more complicated) thing is that the rest of the documentation changed and some of the links in this are now outdated. If you could rebase this and change the links that use {{ site.baseurl }} ... to use this syntax {% link dev/stream/state/checkpointing.md %} building the docs will fail on missing links.

Copy link
Contributor

@alpinegizmo alpinegizmo left a comment

Choose a reason for hiding this comment

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

I'm pretty happy with the page as a whole. It covers a coherent set of topics in a helpful way, and connects to the other parts of the documentation that need to be understood alongside this.

Here and there I found some small grammatical issues. And there are a few points where I think other changes are needed. I've provided suggestions in most cases.

docs/concepts/flink-architecture.md Outdated Show resolved Hide resolved
docs/concepts/flink-architecture.md Outdated Show resolved Hide resolved
docs/concepts/flink-architecture.md Outdated Show resolved Hide resolved
docs/concepts/flink-architecture.md Outdated Show resolved Hide resolved
docs/concepts/flink-architecture.md Outdated Show resolved Hide resolved
docs/concepts/flink-architecture.md Outdated Show resolved Hide resolved
docs/concepts/flink-architecture.md Outdated Show resolved Hide resolved
docs/concepts/flink-architecture.md Outdated Show resolved Hide resolved
docs/concepts/flink-architecture.md Outdated Show resolved Hide resolved
docs/concepts/flink-architecture.md Outdated Show resolved Hide resolved
@morsapaes
Copy link
Contributor Author

Thanks for reviewing, @aljoscha and @alpinegizmo! It's weird that the links worked fine in the local build even with the duplicated reference to the base URL — I've corrected that and will also update the Documentation Style Guide.

@aljoscha
Copy link
Contributor

Thanks again, @morsapaes! I merged this.

@aljoscha aljoscha closed this May 25, 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.

5 participants