[Hotfix][docs] Fixed typos.

[RocMarshal]

What is the purpose of the change

Fixed typos

Brief change log

Fixed typos

Verifying this change

Fixed typos

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, 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]

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 601bd5d (Thu Sep 23 17:52:43 UTC 2021)

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.

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]

CI report:

• 601bd5d Azure: SUCCESS

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

[tisonkun]

It is not a typo.

Closing...

[RocMarshal]

@dianfu ,@tisonkun Hi, I attach 3 pics about it. PTAL. Thank you.

[tisonkun]

flink/flink-yarn/pom.xml

Lines 44 to 54 in 2a7e7d7

	<dependency>
	<groupId>org.apache.flink</groupId>
	<artifactId>flink-runtime_${scala.binary.version}</artifactId>
	<version>${project.version}</version>
	</dependency>
	<dependency>
	<groupId>org.apache.flink</groupId>
	<artifactId>flink-clients_${scala.binary.version}</artifactId>
	<version>${project.version}</version>
	</dependency>

@RocMarshal nope. Our codebase is in the pattern flink-runtime_${scala.binary.version}.

If you suffer from double underscore issue, you can provide minimal reproduce steps and seek the cause.

[RocMarshal]

flink/flink-yarn/pom.xml

Lines 44 to 54 in 2a7e7d7

	<dependency>
	<groupId>org.apache.flink</groupId>
	<artifactId>flink-runtime_${scala.binary.version}</artifactId>
	<version>${project.version}</version>
	</dependency>
	<dependency>
	<groupId>org.apache.flink</groupId>
	<artifactId>flink-clients_${scala.binary.version}</artifactId>
	<version>${project.version}</version>
	</dependency>

@RocMarshal nope. Our codebase is in the pattern flink-runtime_${scala.binary.version}.

If you suffer from double underscore issue, you can provide minimal reproduce steps and seek the cause.

@tisonkun Yes, our codebase is in the pattern flink-runtime_${scala.binary.version}. However, the value of variable scala_version in documentation configuration is _2.11. So, double underscore was shown in the page . Thank you for your attention.

[tisonkun]

Thanks for your detailed analyze @RocMarshal ! You're right that this pull request could be a valid fix.

I found the root cause that we config scala version with a prefix underscore

flink/docs/config.toml

Line 55 in 4cc1246

ScalaVersion = "_2.11"

I don't know whether or not we handle this case properly, though. That is, if we have to create a series of "fix typo" to handle this pattern. Generally I think a variable named "ScalaVersion" should be "2.11" instead of "_2.11" and we handle the prefix underscore separately, which is what we do in the prod codebase.

Would you mind to do an investigation and handle this config properly?

[RocMarshal]

@tisonkun Thank you for your reply. I found this problem during the investigation of version upgrade.
It’s probably that ScalaVersion = "_2.11" was discussed carefully when the documentation was upgraded.
And there are many typos about variable reference site.scala_version_suffix and site.version instead of scala_version and version.

I'm not sure that we should keep ScalaVersion = "_2.11" or update it to ScalaVersion = "2.11". The former requires fewer changes, while the latter requires more changes, but can be read better.
Please let me know your opinions.

[tisonkun]

I go through the codebase and it seems only this section suffer the underscore issue. Let's postpone the discussion of style later.

[tisonkun]

Thank you! Merging...