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

[to #426] update maven site info in README.md #504

Merged
merged 4 commits into from
Feb 13, 2022

Conversation

iosmanthus
Copy link
Member

Signed-off-by: iosmanthus myosmanthustree@gmail.com

What problem does this PR solve?

Issue Number: close #426

What is changed and how does it work?

This pull request updates maven site info in README since API docs are moved to the maven site of this project.

Signed-off-by: iosmanthus <myosmanthustree@gmail.com>
Signed-off-by: iosmanthus <myosmanthustree@gmail.com>
Copy link
Member

@zz-jason zz-jason 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

@marsishandsome marsishandsome left a comment

Choose a reason for hiding this comment

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

LGTM

README.md Outdated
@@ -50,7 +50,9 @@ Find more demo in [KVRawClientTest](https://github.com/birdstorm/KVRawClientTest

See [Java Client Documents](/docs/README.md) for references about how to config and monitor Java Client.

An [API reference](https://tikv.github.io/client-java/apidocs) is also available.
A [Maven site](https://tikv.github.io/client-java/site) is also available. It includes:
1. [API reference](https://tikv.github.io/client-java/site/xref/index.html)
Copy link
Member

Choose a reason for hiding this comment

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

This seems not an API reference, but a source code viewer. The API reference is missing now.

Copy link
Member Author

Choose a reason for hiding this comment

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

OH! I am writing a patch adding a reporting plugin for API refs in the maven site.

@iosmanthus iosmanthus changed the title [to #426] update maven site info in README.md [DNM] [to #426] update maven site info in README.md Feb 10, 2022
@iosmanthus
Copy link
Member Author

@peng1999 FYI #507

@iosmanthus
Copy link
Member Author

DNM until #507 is resolved.

Signed-off-by: iosmanthus <myosmanthustree@gmail.com>
@iosmanthus iosmanthus changed the title [DNM] [to #426] update maven site info in README.md [to #426] update maven site info in README.md Feb 11, 2022
@iosmanthus
Copy link
Member Author

@peng1999 PTAL

@iosmanthus
Copy link
Member Author

/merge

@ti-srebot
Copy link
Collaborator

/run-all-tests

@zz-jason zz-jason merged commit 7f65fc6 into tikv:master Feb 13, 2022
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.

Troubleshoot problems scanned by SpotBugs
5 participants