Skip to content

doc: README.md tiny improve #2331

Merged
imbajin merged 2 commits intoapache:masterfrom
aroundabout:doc-opt
Oct 23, 2023
Merged

doc: README.md tiny improve #2331
imbajin merged 2 commits intoapache:masterfrom
aroundabout:doc-opt

Conversation

@aroundabout
Copy link
Copy Markdown
Contributor

Purpose of the PR

Main Changes

Verifying these changes

  • Trivial rework / code cleanup without any test coverage. (No Need)
  • Already covered by existing tests, such as (please modify tests here).
  • Need tests and can be verified as follows:
    • xxx

Does this PR potentially affect the following parts?

  • Nope
  • Dependencies (add/update license info)
  • Modify configurations
  • The public API
  • Other affects (typed here)

Documentation Status

  • Doc - TODO
  • Doc - Done
  • Doc - No Need

@codecov
Copy link
Copy Markdown

codecov bot commented Oct 20, 2023

Codecov Report

Merging #2331 (f7bc161) into master (869fc81) will increase coverage by 1.08%.
The diff coverage is n/a.

@@             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

imbajin
imbajin previously approved these changes Oct 21, 2023
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:
Copy link
Copy Markdown
Contributor

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"

Copy link
Copy Markdown
Contributor

@javeme javeme left a comment

Choose a reason for hiding this comment

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

LGTM

@imbajin imbajin merged commit 73329ce into apache:master Oct 23, 2023
VGalaxies pushed a commit to VGalaxies/incubator-hugegraph that referenced this pull request Nov 10, 2023
imbajin pushed a commit that referenced this pull request Nov 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants