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

[close #325] Update README docs #326

Merged
merged 1 commit into from
Dec 10, 2022
Merged

Conversation

haojinming
Copy link
Contributor

Signed-off-by: haojinming [email protected]

What problem does this PR solve?

Issue Number: close #325

Problem Description:

What is changed and how does it work?

Update README.md and README-cn.md, link to tikv.org.

Code changes

  • No code

Check List for Tests

This PR has been tested by at least one of the following methods:

  • No code

Side effects

  • No side effects

Related changes

  • No related changes

To reviewers

Please follow these principles to check this pull requests:

  • Concentration. One pull request should only do one thing. No matter how small it is, the change does exactly one thing and gets it right. Don't mix other changes into it.
  • Tests. A pull request should be test covered, whether the tests are unit tests, integration tests, or end-to-end tests. Tests should be sufficient, correct and don't slow down the CI pipeline largely.
  • Functionality. The pull request should implement what the author intends to do and fit well in the existing code base, resolve a real problem for TiDB/TiKV users. To get the author's intention and the pull request design, you could follow the discussions in the corresponding GitHub issue or internal.tidb.io topic.
  • Style. Code in the pull request should follow common programming style. (For Go, we have style checkers in CI). However, sometimes the existing code is inconsistent with the style guide, you should maintain consistency with the existing code or file a new issue to fix the existing code style first.
  • Documentation. If a pull request changes how users build, test, interact with, or release code, you must check whether it also updates the related documentation such as READMEs and any generated reference docs. Similarly, if a pull request deletes or deprecates code, you must check whether or not the corresponding documentation should also be deleted.
  • Performance. If you find the pull request may affect performance, you could ask the author to provide a benchmark result.

(The above text mainly refers to TiDB Development Guide. It's also highly recommended to read about Writing code review comments)

Signed-off-by: haojinming <[email protected]>
@haojinming haojinming requested review from pingyu and zeminzhou and removed request for pingyu December 6, 2022 02:43
@codecov
Copy link

codecov bot commented Dec 6, 2022

Codecov Report

Merging #326 (208f566) into main (0077830) will decrease coverage by 0.1001%.
The diff coverage is 0.0000%.

Additional details and impacted files

Impacted file tree graph

@@               Coverage Diff                @@
##               main       #326        +/-   ##
================================================
- Coverage   61.0618%   60.9617%   -0.1002%     
================================================
  Files           240        239         -1     
  Lines         20286      20339        +53     
================================================
+ Hits          12387      12399        +12     
- Misses         6779       6822        +43     
+ Partials       1120       1118         -2     
Flag Coverage Δ
br 60.5320% <ø> (ø)
cdc 61.1602% <0.0000%> (-0.1474%) ⬇️
Impacted Files Coverage Δ
cdc/cdc/sorter/unified/backend_pool.go 66.9811% <ø> (ø)
cdc/cdc/sorter/unified/file_backend.go 33.3333% <0.0000%> (-0.4387%) ⬇️
cdc/cdc/kv/client.go 84.0057% <0.0000%> (-2.0173%) ⬇️
cdc/cdc/sorter/unified/heap_sorter.go 85.7142% <0.0000%> (-1.5307%) ⬇️
cdc/cdc/server.go 35.1851% <0.0000%> (-0.8338%) ⬇️
cdc/cdc/http_router.go 81.4814% <0.0000%> (-0.5186%) ⬇️
cdc/cdc/kv/matcher.go 100.0000% <0.0000%> (ø)
cdc/cdc/capture/capture.go 0.0000% <0.0000%> (ø)
cdc/cdc/kv/region_worker.go 79.5833% <0.0000%> (ø)
cdc/cmd/cdc/main.go
... and 5 more

@haojinming haojinming changed the title [close #325] Update user manual [close #325] Update README docs Dec 6, 2022
@haojinming haojinming closed this Dec 6, 2022
@haojinming haojinming reopened this Dec 6, 2022
Copy link
Contributor

@zeminzhou zeminzhou 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
Collaborator

@pingyu pingyu left a comment

Choose a reason for hiding this comment

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

LGTM~

@pingyu pingyu merged commit 0966ba8 into tikv:main Dec 10, 2022
@haojinming haojinming deleted the update_tikv_br_docs branch December 10, 2022 08:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

br: update docs's link to tikv.org
3 participants