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

[docs] Improve the readme and issue template #3383

Merged
merged 3 commits into from
Jun 5, 2024

Conversation

leonardBang
Copy link
Contributor

Improve the readme and issue template

@github-actions github-actions bot added docs Improvements or additions to documentation build labels May 30, 2024
@@ -47,6 +50,8 @@ body:
感谢您选择 Flink CDC!

由于 Apache Flink 的要求,请在 [Apache Jira](https://issues.apache.org/jira) 的 `Flink` 项目下使用 `Flink CDC` 标签来反馈缺陷或新功能。
您需要登录 Jira 帐户才能创建 issue 去记录缺陷或新功能,如果您没有 Apache JIRA 帐户,您可以在 [ASF Jira 账号](https://selfserve.apache.org/jira-account.html)
申请账号,账号创建会由申请项目的 PMC member 审核,通常一到两个工作日可以通过。
Copy link
Member

Choose a reason for hiding this comment

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

ASF Self-serve portal == ASF Jira 账号?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

selfserve.apache.org/jira-account == ASF Jira 账号

Copy link
Contributor Author

Choose a reason for hiding this comment

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

本意是想照顾下中文用户,特别是新用户,使用 “ASF自助服务门户” 会让中文新用户特别懵,所以还是“ ASF Jira 账号” 用户好理解

Copy link
Member

@caicancai caicancai left a comment

Choose a reason for hiding this comment

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

overall LGTM.
I left a small comment

Copy link
Contributor

@loserwang1024 loserwang1024 left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Contributor

@Jiabao-Sun Jiabao-Sun left a comment

Choose a reason for hiding this comment

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

LGTM

@leonardBang leonardBang merged commit e817cc2 into apache:master Jun 5, 2024
14 checks passed
Copy link
Contributor

@PatrickRen PatrickRen left a comment

Choose a reason for hiding this comment

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

@leonardBang Thanks for the patch! LGTM.

What about linking the PR to a Jira issue?

@leonardBang
Copy link
Contributor Author

leonardBang commented Jun 5, 2024

What about linking the PR to a Jira issue?

That's better but this is a minor doc improvement, thus I didn't open a jira ticket.

wuzhenhua01 pushed a commit to wuzhenhua01/flink-cdc-connectors that referenced this pull request Aug 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants