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-24742][table][docs] Add info about SQL client key strokes to docs #17649

Merged
merged 4 commits into from
Nov 22, 2022

Conversation

snuyanzin
Copy link
Contributor

What is the purpose of the change

The PR adds info about key-strokes in SQL client to docs

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, 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
Copy link
Collaborator

flinkbot commented Nov 2, 2021

CI report:

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

@flinkbot
Copy link
Collaborator

flinkbot commented Nov 2, 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 7081987 (Tue Nov 02 22:30:36 UTC 2021)

Warnings:

  • Documentation files were touched, but no docs/content.zh/ files: Update Chinese documentation or file Jira ticket.
  • This pull request references an unassigned Jira ticket. According to the code contribution guide, tickets need to be assigned before starting with the implementation work.

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

@snuyanzin
Copy link
Contributor Author

Hi @MartijnVisser.
Sorry for the poke. Since you are one of the committers dealing with doc, could you please have a look once you have time?

Copy link
Contributor

@MartijnVisser MartijnVisser 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 PR! It would be great if we can figure something out to also cover Mac keyboard users before merging this?

docs/content/docs/dev/table/sqlClient.md Show resolved Hide resolved
@snuyanzin
Copy link
Contributor Author

Added for Mac (tested on 2 relatively old Macs (before M1))
Please let me know in case I need to rebase

Copy link
Contributor

@XComp XComp left a comment

Choose a reason for hiding this comment

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

I checked the Linux short cuts. The MacOS short cuts look reasonable comparing it to the Linux once. I have two suggestions but generally, it looks fine.

docs/content/docs/dev/table/sqlClient.md Outdated Show resolved Hide resolved
docs/content/docs/dev/table/sqlClient.md Outdated Show resolved Hide resolved
@snuyanzin
Copy link
Contributor Author

@flinkbot run azure

the failure is related to https://issues.apache.org/jira/browse/FLINK-24119

@snuyanzin
Copy link
Contributor Author

@flinkbot run azure

@snuyanzin snuyanzin requested review from XComp and MartijnVisser and removed request for MartijnVisser and XComp October 31, 2022 16:00
@XComp
Copy link
Contributor

XComp commented Nov 1, 2022

@MartijnVisser Are we ok to merge that?

@MartijnVisser
Copy link
Contributor

Yeah I think it's fine

Copy link
Contributor

@XComp XComp left a comment

Choose a reason for hiding this comment

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

Sorry that I missed that in the first round but could you add the section to the Chinese version of the documentation as well? Copy&paste should be good enough. It looks like this is the right location for including the subsection.

@snuyanzin
Copy link
Contributor Author

@flinkbot run azure

@snuyanzin
Copy link
Contributor Author

Rebased since latest failure is related to removed elasticsearch module and the PR was done before it happened

@XComp XComp merged commit f21090b into apache:master Nov 22, 2022
akkinenivijay pushed a commit to krisnaru/flink that referenced this pull request Feb 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
5 participants