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-18377] Rename "Flink Master" back to JobManager in documentation #12723

Closed

Conversation

aljoscha
Copy link
Contributor

@aljoscha aljoscha commented Jun 19, 2020

What is the purpose of the change

Please see https://issues.apache.org/jira/browse/FLINK-18377 for a full description. The gist of it is that we want to get rid of the word "master".

Brief change log

  • change glossary.md/glossary.zh.md to update definition of JobManager and JobMaster
  • rename mem_setup_master.md to mem_setup_jobmanager.md (same for .zh). I didn't create redirects for this because the file was newly added for Flink 1.11
  • change occurences of Flink Master to JobManager in the rest of the docs
  • on the way I also changed a couple of links to use the better {% link ... syntax, this should help catch dead links better
  • add a second commit to update Jekyll from 4.0.0 to 4.0.1 to fix compile warnings on Ruby 2.7

There is still an entry for JobMaster in the glossary. I could remove that one as well. The only mentions of master in the doc are now for the JobMaster.

Verifying this change

  • manually check renamings
  • build documentation to see that all links are still valid

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

It's a pure documentation change.

Building the docs with Ruby 2.7 and Jekyll 4.0.0 spits out a lot of
warnings, see jekyll/jekyll#7947. Updating to
4.0.1 fixes this.
@flinkbot
Copy link
Collaborator

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 e090f55 (Fri Jun 19 12:50:40 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

@flinkbot
Copy link
Collaborator

flinkbot commented Jun 19, 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

Copy link
Contributor

@zentol zentol left a comment

Choose a reason for hiding this comment

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

Maybe do another sweep for "Masters"

docs/Gemfile.lock Show resolved Hide resolved
docs/concepts/glossary.md Outdated Show resolved Hide resolved
docs/learn-flink/datastream_api.zh.md Outdated Show resolved Hide resolved
docs/ops/deployment/docker.md Show resolved Hide resolved
docs/ops/security-ssl.zh.md Show resolved Hide resolved
docs/ops/memory/mem_trouble.md Outdated Show resolved Hide resolved
docs/ops/memory/mem_setup_tm.md Outdated Show resolved Hide resolved
docs/ops/memory/mem_migration.md Outdated Show resolved Hide resolved
aljoscha and others added 5 commits June 19, 2020 16:36
Co-authored-by: Chesnay Schepler <chesnay@apache.org>
Co-authored-by: Chesnay Schepler <chesnay@apache.org>
Co-authored-by: Chesnay Schepler <chesnay@apache.org>
Co-authored-by: Chesnay Schepler <chesnay@apache.org>
@aljoscha
Copy link
Contributor Author

I pushed changes, PTAL.

Also, thanks for the speedy review!

Before, we used JobManager/Flink Workers, not we use
JobManager/TaskManagers for the section titles.
@aljoscha
Copy link
Contributor Author

Copy link
Contributor

@zentol zentol left a comment

Choose a reason for hiding this comment

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

+1

@aljoscha
Copy link
Contributor Author

Thanks for the reviews! I merged.

Btw, I thought about adding release notes but we didn't announce the earlier renaming and the documentation was in enough of a mixed state that I would do this silently.

@aljoscha aljoscha closed this Jun 22, 2020
@aljoscha aljoscha deleted the flink-18377-back-to-jobmanager branch June 22, 2020 09:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants