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

[hotfix][docs] Fix some typos and sample codes syntax issues in sever… #15691

Merged
merged 1 commit into from
Apr 23, 2021

Conversation

paul8263
Copy link
Contributor

…al sections

What is the purpose of the change

Fix some typos and sample codes syntax issues in several chapters.

Brief change log

Correct the issues in the following files:

  • docs/content/docs/internals/filesystems.md
  • docs/content/docs/learn-flink/datastream_api.md
  • docs/content/docs/libs/gelly/graph_algorithms.md
  • docs/content/docs/libs/cep.md
  • docs/content/docs/libs/state_processor_api.md
  • docs/content/docs/ops/metrics.md
  • docs/content/docs/try-flink/datastream.md
  • docs/content/docs/try-flink/flink-operations-playground.md
  • docs/content/docs/try-flink/table_api.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
  • If yes, how is the feature documented? not applicable

@flinkbot
Copy link
Collaborator

flinkbot commented Apr 21, 2021

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 b123394 (Fri May 28 09:12:47 UTC 2021)

✅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 Apr 21, 2021

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

@@ -653,7 +653,7 @@ Pattern<Event, ?> strict = start.next("middle").where(...);
Pattern<Event, ?> relaxed = start.followedBy("middle").where(...);

// non-deterministic relaxed contiguity
Pattern<Event, ?> nonDetermin = start.followedByAny("middle").where(...);
Pattern<Event, ?> nonDetermine = start.followedByAny("middle").where(...);
Copy link
Contributor

Choose a reason for hiding this comment

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

This isn't really a typo; its ust an abbreviation for nonDeterministic

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks zentol. I have just rolled back those commits in cep.md.

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.

Could you also fix the code-related issues in the chinese version of the docs? (under docs/content.zh)

@paul8263
Copy link
Contributor Author

Could you also fix the code-related issues in the chinese version of the docs? (under docs/content.zh)

Those corresponding typos and syntax issues were fixed in docs/content.zh folder. Is there anything else I can help?

@zentol
Copy link
Contributor

zentol commented Apr 23, 2021

@paul8263 Thanks, this will do 👍

@zentol zentol merged commit 6a7a1d9 into apache:master Apr 23, 2021
@paul8263 paul8263 deleted the hotfix_document branch August 6, 2021 04:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants