Skip to content

Conversation

slinkydeveloper
Copy link
Contributor

What is the purpose of the change

This PR adds a new page to add module specific guides for flink contributors.

Brief change log

  • Added the new module specific guides doc page
  • Added how to debug the sql planner guide

Verifying this change

This change is only docs

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: (yes / no / don't know)
  • The runtime per-record code paths (performance sensitive): no
  • Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn, 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

@Airblader
Copy link
Contributor

There seems to be some overlap with https://flink.apache.org/contributing/code-style-and-quality-components.html with 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 7593fde (Tue Sep 28 09:13:25 UTC 2021)

Warnings:

  • Documentation files were touched, but no docs/content.zh/ 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

@slinkydeveloper
Copy link
Contributor Author

slinkydeveloper commented Sep 28, 2021

@Airblader yep it seems like, perhaps I can modify the page you linked to be more "generic", and not specific to code style? Or do you have something else in mind?

@flinkbot
Copy link
Collaborator

flinkbot commented Sep 28, 2021

CI report:

Bot commands The @flinkbot bot supports the following commands:
  • @flinkbot run azure re-run the last Azure build

@slinkydeveloper
Copy link
Contributor Author

Moved to apache/flink-web#480

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants