[ISSUE-375] Optimize the Quick Start documentation to allow users to experience it more quickly #376
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
652053395
reviewed
Nov 18, 2024
README.md
Outdated
| @@ -38,10 +38,10 @@ For GeaFlow design paper: [GeaFlow: A Graph Extended and Accelerated Dataflow Sy | |||
|
|
|||
| 1. Prepare Git、JDK8、Maven、Docker environment。 | |||
| 2. Download Code：`git clone https://github.com/TuGraph-family/tugraph-analytics` | |||
| 3. Build Project：`mvn clean install -DskipTests` | |||
| 3. Build Project：`./build.sh --module=gealfow --output=package` or `mvn clean install -DskipTests` | |||
652053395
reviewed
Nov 18, 2024
| @@ -38,10 +38,10 @@ For GeaFlow design paper: [GeaFlow: A Graph Extended and Accelerated Dataflow Sy | |||
|
|
|||
| 1. Prepare Git、JDK8、Maven、Docker environment。 | |||
| 2. Download Code：`git clone https://github.com/TuGraph-family/tugraph-analytics` | |||
| 3. Build Project：`mvn clean install -DskipTests` | |||
| 3. Build Project：`./build.sh --module=gealfow --output=package` or `mvn clean install -DskipTests` | |||
| 4. Test Job：`./bin/gql_submit.sh --gql geaflow/geaflow-examples/gql/loop_detection.sql` | |||
There was a problem hiding this comment.
这里是不是可以分成2段， 黑屏demo和白屏
652053395
approved these changes
Nov 19, 2024
Leomrlin
requested review from
Loognqiang
and removed request for
Loognqiang
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.
Optimize the Quick Start documentation to allow users to experience it more quickly #375
According to the current Quick Start guide, users need to build the entire engine and console images to experience the demo case, which is time-consuming. To help users experience the Quick Start demo more quickly, the documentation should be optimized to specify that, when running demos that only rely on the engine JAR package, users only need to package the engine without building images. When running demos that rely on both the console image and the JAR package, users only need to build both.