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-12639] [docs] add "getting started" section to documentation #8873

Merged
merged 1 commit into from Jun 27, 2019

Conversation

knaufk
Copy link
Contributor

@knaufk knaufk commented Jun 25, 2019

What is the purpose of the change

Add a "Getting Started" section to the documentation to expand in the course of FLIP-42. This change only the existing content into the target structure.

Brief change log

see above

Verifying this change

build docs and check result

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-reord code paths (performance sensitive): no
  • Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, 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 Jun 25, 2019

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.

Review Progress

  • ✅ 1. The [description] looks good.
    • Approved by @NicoK [committer]
  • ✅ 2. There is [consensus] that the contribution should go into to Flink.
    • Approved by @NicoK [committer]
  • ❓ 3. Needs [attention] from.
  • ✅ 4. The change fits into the overall [architecture].
    • Approved by @NicoK [committer]
  • ✅ 5. Overall code [quality] is good.
    • Approved by @NicoK [committer]

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

@sjwiesman
Copy link
Contributor

@knaufk built locally and looks good +1, feel free to have someone merge

@knaufk
Copy link
Contributor Author

knaufk commented Jun 26, 2019

@sjwiesman Thanks a lot for review.

@NicoK
Copy link
Contributor

NicoK commented Jun 27, 2019

@flinkbot approve all

@NicoK NicoK merged commit e377bf6 into apache:master Jun 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
5 participants