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 #348] use mdbook and github action to maintain documents #407

Merged
merged 4 commits into from
Dec 15, 2021

Conversation

zz-jason
Copy link
Member

What problem does this PR solve?

Issue Number: to #348

Problem Description: we don't have public and systematic user and contributor documents

What is changed and how it works?

  1. combine all the developer and contributor related documents into ./docs
  2. use mdbook and github actions to auto-generate the documents in each PR.

Code changes

  • No code

Check List for Tests

  • No code

Side effects

  • NO side effects

Related changes

  • NO related changes

Signed-off-by: Jian Zhang <zjsariel@gmail.com>
Signed-off-by: Jian Zhang <zjsariel@gmail.com>
Signed-off-by: Jian Zhang <zjsariel@gmail.com>
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

Signed-off-by: Jian Zhang <zjsariel@gmail.com>
@zz-jason
Copy link
Member Author

/merge

@ti-srebot
Copy link
Collaborator

/run-all-tests

@ti-srebot
Copy link
Collaborator

@zz-jason merge failed.

Copy link
Member

@iosmanthus iosmanthus left a comment

Choose a reason for hiding this comment

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

LGTM

@zz-jason zz-jason merged commit 911f2c5 into tikv:master Dec 15, 2021
@zz-jason zz-jason deleted the refactor/mdbook-docs branch December 15, 2021 07:40
@zz-jason
Copy link
Member Author

seems the failed test can be fixed by #383

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.

None yet

4 participants