[FLINK-23028][docs] Improve documentation for pages of SQL. #16070

RocMarshal · 2021-06-03T12:14:59Z

What is the purpose of the change

Improve documentation for pages of SQL.

Brief change log

Correct wrong style in https://ci.apache.org/projects/flink/flink-docs-master/zh/docs/dev/table/sql/create/#create-function section.

Correct wrong style in https://ci.apache.org/projects/flink/flink-docs-master/zh/docs/dev/table/sql/drop/#drop-function section.

Correct wrong style in https://ci.apache.org/projects/flink/flink-docs-master/zh/docs/dev/table/sql/alter/#alter-function section.

Add the description about drop catalog in the page of https://ci.apache.org/projects/flink/flink-docs-master/docs/dev/table/sql/drop/ .

Correct 'catloag' of https://ci.apache.org/projects/flink/flink-docs-master/zh/docs/dev/table/sql/use/#use-catloag

A pure documentation work.

Verifying this change

Correct wrong style in https://ci.apache.org/projects/flink/flink-docs-master/zh/docs/dev/table/sql/create/#create-function section.

Correct wrong style in https://ci.apache.org/projects/flink/flink-docs-master/zh/docs/dev/table/sql/drop/#drop-function section.

Correct wrong style in https://ci.apache.org/projects/flink/flink-docs-master/zh/docs/dev/table/sql/alter/#alter-function section.

Add the description about drop catalog in the page of https://ci.apache.org/projects/flink/flink-docs-master/docs/dev/table/sql/drop/ .

Correct 'catloag' of https://ci.apache.org/projects/flink/flink-docs-master/zh/docs/dev/table/sql/use/#use-catloag

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/Mesos, 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 · 2021-06-03T12:23:45Z

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 9fef89f (Thu Jun 03 12:23:45 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 · 2021-06-03T12:50:32Z

CI report:

934f681 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

RocMarshal · 2021-06-11T00:35:41Z

@alpinegizmo @dianfu Could you help me to review this PR? Thank you.

alpinegizmo

I've left one suggestion for improving the English.

docs/content/docs/dev/table/sql/drop.md

Co-authored-by: David Anderson <[email protected]>

RocMarshal · 2021-06-18T10:40:56Z

@flinkbot run azure

Airblader

Thanks for your PR! Could you please double-check all of these also in both the Chinese and English versions of those pages and fix it in both? Thank you!

RocMarshal · 2021-06-22T02:52:00Z

@Airblader Thank you for your suggestions. I did some checking based on your comments, but it seems that the problem described in JIRA has been fixed now.

RocMarshal · 2021-06-23T08:45:17Z

@gaoyunhaii Could you help me to review this PR? Thank you.

gaoyunhaii · 2021-06-24T02:55:20Z

docs/content.zh/docs/dev/table/sql/drop.md

+DROP CATALOG [IF EXISTS] catalog_name
+```
+
+删除给定的 catalog name 的 catalog。


删除给定名子的 Catalog ?

gaoyunhaii · 2021-06-24T02:56:27Z

docs/content.zh/docs/dev/table/sql/drop.md

+
+**IF EXISTS**
+
+如果目标 catalog 不存在，则不会生效。


则不会生效 => 不会执行任何操作？

gaoyunhaii · 2021-06-24T03:15:49Z

Hi @RocMarshal Very thanks for the contribution ! I checked the style fix and it should indeed works. I left two small comments regarding the Chinese description. The other part LGTM.

RocMarshal · 2021-06-24T07:01:32Z

@gaoyunhaii Thank you for your review. I made some changes based on your comments.
PTAL.

gaoyunhaii · 2021-06-25T02:53:45Z

Thanks @RocMarshal for the update and LGTM now, and we would still need a committer to finally confirm and merge the PR~

RocMarshal · 2021-06-25T06:31:29Z

Hi, @alpinegizmo @wuchong ,Could you help me to confirm and merge the PR ? Thank you so much for your help.

JingsongLi

Thanks @RocMarshal ! The PR looks good to me!

JingsongLi

And thanks @alpinegizmo and @gaoyunhaii for the review. I will merge this PR~

rmetzger added the review=description? label Jun 3, 2021

alpinegizmo reviewed Jun 11, 2021

View reviewed changes

docs/content/docs/dev/table/sql/drop.md Outdated Show resolved Hide resolved

RocMarshal requested a review from alpinegizmo June 11, 2021 09:37

RocMarshal force-pushed the Hotfix-210603 branch from 0bd24ad to 538cd02 Compare June 15, 2021 04:53

RocMarshal changed the title ~~[HOTFIX][docs] Fix typos.~~ [Hotfix][docs] Fix typos. Jun 17, 2021

RocMarshal changed the title ~~[Hotfix][docs] Fix typos.~~ [FLINK-23028][docs] Improve documentation for pages of SQL. Jun 18, 2021

rmetzger added the component=Documentation label Jun 18, 2021

RocMarshal and others added 4 commits June 18, 2021 15:53

[FLINK-23028][docs] Improve documentation for pages of SQL.

cf2f55b

[FLINK-23028][docs] Improve documentation for pages of SQL.

73e2b93

Update docs/content/docs/dev/table/sql/drop.md

9b02043

Co-authored-by: David Anderson <[email protected]>

[FLINK-23028][docs] Improve documentation for pages of SQL.

5f48224

RocMarshal force-pushed the Hotfix-210603 branch from 538cd02 to 5f48224 Compare June 18, 2021 10:12

Airblader requested changes Jun 21, 2021

View reviewed changes

gaoyunhaii reviewed Jun 24, 2021

View reviewed changes

Update based on gaoyunhaii's comments

934f681

JingsongLi approved these changes Jun 25, 2021

View reviewed changes

JingsongLi reviewed Jun 25, 2021

View reviewed changes

JingsongLi merged commit b116a4e into apache:master Jun 25, 2021

flinkbot added the component=TableSQL/API label Mar 17, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FLINK-23028][docs] Improve documentation for pages of SQL. #16070

[FLINK-23028][docs] Improve documentation for pages of SQL. #16070

RocMarshal commented Jun 3, 2021 •

edited

Loading

flinkbot commented Jun 3, 2021

flinkbot commented Jun 3, 2021 •

edited

Loading

RocMarshal commented Jun 11, 2021

alpinegizmo left a comment

RocMarshal commented Jun 18, 2021

Airblader left a comment •

edited

Loading

RocMarshal commented Jun 22, 2021

RocMarshal commented Jun 23, 2021

gaoyunhaii Jun 24, 2021

gaoyunhaii Jun 24, 2021

gaoyunhaii commented Jun 24, 2021

RocMarshal commented Jun 24, 2021

gaoyunhaii commented Jun 25, 2021

RocMarshal commented Jun 25, 2021

JingsongLi left a comment

JingsongLi left a comment


		IF EXISTS

		如果目标 catalog 不存在，则不会生效。

[FLINK-23028][docs] Improve documentation for pages of SQL. #16070

[FLINK-23028][docs] Improve documentation for pages of SQL. #16070

Conversation

RocMarshal commented Jun 3, 2021 • edited Loading

What is the purpose of the change

Brief change log

Verifying this change

Does this pull request potentially affect one of the following parts:

Documentation

flinkbot commented Jun 3, 2021

Automated Checks

Review Progress

flinkbot commented Jun 3, 2021 • edited Loading

CI report:

RocMarshal commented Jun 11, 2021

alpinegizmo left a comment

Choose a reason for hiding this comment

RocMarshal commented Jun 18, 2021

Airblader left a comment • edited Loading

Choose a reason for hiding this comment

RocMarshal commented Jun 22, 2021

RocMarshal commented Jun 23, 2021

gaoyunhaii Jun 24, 2021

Choose a reason for hiding this comment

gaoyunhaii Jun 24, 2021

Choose a reason for hiding this comment

gaoyunhaii commented Jun 24, 2021

RocMarshal commented Jun 24, 2021

gaoyunhaii commented Jun 25, 2021

RocMarshal commented Jun 25, 2021

JingsongLi left a comment

Choose a reason for hiding this comment

JingsongLi left a comment

Choose a reason for hiding this comment

RocMarshal commented Jun 3, 2021 •

edited

Loading

flinkbot commented Jun 3, 2021 •

edited

Loading

Airblader left a comment •

edited

Loading