-
Notifications
You must be signed in to change notification settings - Fork 520
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
doc: README.md tiny improve #2331
Conversation
Codecov Report
@@ Coverage Diff @@
## master #2331 +/- ##
============================================
+ Coverage 63.85% 64.93% +1.08%
- Complexity 684 987 +303
============================================
Files 505 505
Lines 41902 41902
Branches 5817 5817
============================================
+ Hits 26756 27210 +454
+ Misses 12455 12000 -455
- Partials 2691 2692 +1 see 29 files with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
hugegraph-dist/README.md
Outdated
@@ -10,7 +10,7 @@ We can use docker to quickly start an inner HugeGraph server with RocksDB in bac | |||
|
|||
2. Using docker compose | |||
|
|||
We can also use `docker-compose up -d`. The `docker-compose.yaml` is below: | |||
Additionally, if we want to manage other Hugegraph-related instances with `server` in a single file, we can also use docker-compose for deployment. (Certainly we can only deploy server without other instance) We can also use `docker-compose up -d`. The `docker-compose.yaml` is below: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Hugegraph-related => HugeGraph-related.
- "(Certainly we can only deploy server without other instance)" -- move to the first line? like "Certainly We can deploy server without other instances. Additionally we can also ...".
- To deploy HugeGraph-related instances via
docker-compose up -d
. - "is below" => "is as below"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Purpose of the PR
Main Changes
Verifying these changes
Does this PR potentially affect the following parts?
Documentation Status
Doc - TODO
Doc - Done
Doc - No Need