[BitSail] Improve quickstart documentation #34
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hk-lrzy
reviewed
Oct 24, 2022
docs/quickstart.md
Outdated
| ``` | ||
| bash build.sh | ||
| ``` | ||
| - After the build completed, you can find the jar file under the path `bitsail-dist/target/bitsail-dist-1.0.0-SNAPSHOT-bin/bitsail-archive-1.0.0-SNAPSHOT` |
There was a problem hiding this comment.
should use ${version} to repalce 1.0.0?
docs/quickstart.md
Outdated
| ## Run Local Integration Tests | ||
| ### Prerequisite | ||
| - JDK8 | ||
| - maven 3.5.3+ |
There was a problem hiding this comment.
https://github.com/bytedance/bitsail/blob/master/README.md
have confict witch readme.md file.
Co-authored-by: liyanjia.gary <liyanjia.gary@bytedance.com>
garyli1019
force-pushed
the
doc-improve
branch
from
b41363e
to
7cb3dee
Compare
Co-authored-by: liyanjia.gary <liyanjia.gary@bytedance.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Co-authored-by: liyanjia.gary liyanjia.gary@bytedance.com
Pre-Checklist
Note: Please complete ALL items in the following checklist.
Purpose
Some description about what this PR wants to do.
Approaches
Some description about how this PR achives the purpose.
Related Issues
e.g. Close #796
New Behavior (screenshots if needed)
N/A