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.

Sign up for GitHub

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

Jump to bottom

full document support #348

Closed
zz-jason opened this issue Nov 27, 2021 · 1 comment · Fixed by #507
Closed

full document support #348

zz-jason opened this issue Nov 27, 2021 · 1 comment · Fixed by #507
Assignees
@peng1999

Comments

@zz-jason
Copy link
Member

Is your feature request related to a problem? Please describe.

make users know how to config, use, and monitor the client.

Describe the solution you'd like

  • Examples in using java client
  • Config document
  • API document generated by javadoc
  • Monitor and Alert
  • Troubleshoot
  • Performance Tuning
  • FAG

Describe alternatives you've considered

N/A

Additional context

N/A
@zz-jason
Copy link
Member Author

zz-jason commented Dec 13, 2021 •
edited
Loading

How to maintain the document

  1. Putting the source code to the docs directory
  2. Using mdbook to generate the doc
  3. Add GitHub pages in this repo to show the rendered documents
  4. Auto-generate the rendered documents via GitHub actions or Travis CI in each PR

A simple document structure

@iosmanthus iosmanthus self-assigned this Dec 14, 2021
@zz-jason zz-jason mentioned this issue Dec 14, 2021
Merged
zz-jason added a commit that referenced this issue Dec 14, 2021
@zz-jason
[to #348] refine content in README (#360)
cc9f3b6
@zz-jason zz-jason mentioned this issue Dec 15, 2021
Merged
zz-jason added a commit that referenced this issue Dec 15, 2021
@zz-jason
[to #348] use mdbook and github action to maintain documents (#407)
911f2c5
zz-jason added a commit to zz-jason/client-java that referenced this issue Dec 15, 2021
@zz-jason
[to tikv#348] fix github action not deploy on gh-pages
eeb20e0 
Signed-off-by: Jian Zhang <zjsariel@gmail.com>
@zz-jason zz-jason mentioned this issue Dec 15, 2021
Merged
zz-jason added a commit that referenced this issue Dec 15, 2021
@zz-jason
[to #348] fix gh-pages can not deploy rendered documents (#409)
87f37a5
zz-jason added a commit to zz-jason/client-java that referenced this issue Dec 22, 2021
@zz-jason
[to tikv#348] add introduction for the whole document
87f2e67
@zz-jason zz-jason mentioned this issue Dec 22, 2021
Merged
zz-jason added a commit to zz-jason/client-java that referenced this issue Dec 22, 2021
@zz-jason
[to tikv#348] add introduction for the whole document
63091ab 
Signed-off-by: Jian Zhang <zjsariel@gmail.com>
@marsishandsome marsishandsome moved this to In Progress in TiKV Java Client Sprint Dec 22, 2021
zz-jason added a commit that referenced this issue Dec 22, 2021
@zz-jason
[to #348] add introduction for the whole document (#428)
400aa67
zz-jason added a commit to zz-jason/client-java that referenced this issue Dec 23, 2021
@zz-jason
[to tikv#348] add document about quick start
14f8e6d 
Signed-off-by: Jian Zhang <zjsariel@gmail.com>
@zz-jason zz-jason mentioned this issue Dec 23, 2021
Closed
@peng1999 peng1999 mentioned this issue Dec 27, 2021
Merged
marsishandsome pushed a commit that referenced this issue Dec 28, 2021
@peng1999
[to #348] Add javadoc (#447)
41d11ff 
Signed-off-by: Peng Guanwen <pg999w@outlook.com>
@peng1999 peng1999 mentioned this issue Dec 28, 2021
Merged
@iosmanthus iosmanthus mentioned this issue Feb 10, 2022
Merged
zz-jason pushed a commit that referenced this issue Feb 11, 2022
@peng1999
[to #348] Add examples to docs (#453)
4f13619
zz-jason pushed a commit that referenced this issue Feb 11, 2022
@iosmanthus
[to #348] add javadoc in maven site reporting (#507)
48c309e
Repository owner moved this from WIP to DONE in Java Client Sprint Workbook Feb 11, 2022
Repository owner moved this from In Progress to Done in TiKV Java Client Sprint Feb 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@peng1999 peng1999

Labels
None yet
Projects
Java Client Sprint Workbook
Status: DONE
TiKV Java Client Sprint
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[to #348] add javadoc in maven site reporting iosmanthus/client-java
3 participants
@zz-jason @peng1999 @iosmanthus