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-23750][docs][table] Add documentation for Window Top-N after Windowing TVF. #16983

Merged
merged 3 commits into from
Sep 1, 2021

Conversation

beyond1920
Copy link
Contributor

What is the purpose of the change

The pr adds documentation for Window Top-N after Windowing TVF.

Brief change log

Window-topn.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, 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? (docs)

@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 3443fcb (Wed Aug 25 12:34:42 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 Aug 25, 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

Copy link
Contributor

@godfreyhe godfreyhe left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution @beyond1920 , LGTM overall

docs/content.zh/docs/dev/table/sql/queries/window-topn.md Outdated Show resolved Hide resolved
@godfreyhe
Copy link
Contributor

cc @wuchong

@beyond1920
Copy link
Contributor Author

@godfreyhe Thanks for review, I've updated, please have a look again, thanks.

Copy link
Member

@wuchong wuchong left a comment

Choose a reason for hiding this comment

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

Some links are broken and docs can't build:

➜  docs git:(pull/16983) ✗ ./build_docs.sh
Start building sites … 
WARN 2021/08/27 20:30:27 Expand shortcode is deprecated. Use 'details' instead.
ERROR 2021/08/27 20:30:28 [en] REF_NOT_FOUND: Ref "docs/dev/table/sql/queries/window-join": "/Users/wuchong/Workspace/Flink/flink/docs/content/docs/dev/table/sql/queries/window-topn.md:31:524": page not found
WARN 2021/08/27 20:30:30 Expand shortcode is deprecated. Use 'details' instead.
ERROR 2021/08/27 20:30:31 [zh] REF_NOT_FOUND: Ref "docs/dev/table/sql/queries/window-join": "/Users/wuchong/Workspace/Flink/flink/docs/content.zh/docs/dev/table/sql/queries/window-topn.md:31:524": page not found
Built in 5394 ms
Error: Error building site: logged 2 error(s)

Please preview the docs in local before submitting pull request.

@beyond1920
Copy link
Contributor Author

@wuchong I've updated the doc style. About broken link, window-join link is broken because window join documents are not merged yet. They would be ok after pr is merged.

Copy link
Member

@wuchong wuchong left a comment

Choose a reason for hiding this comment

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

LGTM.

@wuchong wuchong merged commit f946614 into apache:master Sep 1, 2021
wuchong pushed a commit that referenced this pull request Sep 1, 2021
lometheus pushed a commit to lometheus/flink that referenced this pull request Sep 2, 2021
niklassemmler pushed a commit to niklassemmler/flink that referenced this pull request Feb 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
5 participants