Skip to content

doc: adjust docker desc in readme#2390

Merged
simon824 merged 8 commits intoapache:masterfrom
aroundabout:docfix-1.2
Dec 17, 2023
Merged

doc: adjust docker desc in readme#2390
simon824 merged 8 commits intoapache:masterfrom
aroundabout:docfix-1.2

Conversation

@aroundabout
Copy link
Copy Markdown
Contributor

Purpose of the PR

  • add the docker related policy in README
  • make server in docker run in deamon to run stop-hugegraph.sh

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

@aroundabout aroundabout marked this pull request as draft December 15, 2023 13:22
@codecov
Copy link
Copy Markdown

codecov bot commented Dec 15, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (4346b44) 66.27% compared to head (75f7183) 66.21%.

Additional details and impacted files
@@             Coverage Diff              @@
##             master    #2390      +/-   ##
============================================
- Coverage     66.27%   66.21%   -0.07%     
+ Complexity      830      828       -2     
============================================
  Files           511      511              
  Lines         42590    42590              
  Branches       5941     5941              
============================================
- Hits          28227    28201      -26     
- Misses        11558    11576      +18     
- Partials       2805     2813       +8     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@aroundabout aroundabout marked this pull request as ready for review December 15, 2023 15:53
@aroundabout aroundabout changed the title doc: add the docker related policy in readme doc: adjust the docker related desc in readme Dec 16, 2023
@aroundabout aroundabout changed the title doc: adjust the docker related desc in readme doc: adjust docker desc in readme Dec 16, 2023
@imbajin imbajin changed the base branch from release-1.2.0 to master December 16, 2023 15:46
README.md Outdated
### 2. Download Way
### 1. Download Way

Visit [Download Page](https://hugegraph.apache.org/docs/download/download/) and refer the [doc](https://hugegraph.apache.org/docs/quickstart/hugegraph-server/#33-source-code-compilation)
Copy link
Copy Markdown
Member

@imbajin imbajin Dec 16, 2023

Choose a reason for hiding this comment

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

seems the refer doc is not for binary release? (use binary pkg instruction link here)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

seems the refer doc is not for binary release? (use binary pkg instruction link here)

Changed.
But it should be adjusted to sync the doc again (in doc the order of how to get hugegraph will be changed)

Comment on lines -296 to -311
<!-- copy the artifacts to root
directory for better user experience -->
<!-- REMOVE ME after revision 1.5.0 -->
<exec executable="cp"
dir="${project.basedir}"
failonerror="false">
<arg value="-r"/>
<arg value="../${final.name}"/>
<arg value="../../${final.name}"/>
</exec>
<exec executable="cp"
dir="${project.basedir}"
failonerror="false">
<arg value="../${final.name}.tar.gz"/>
<arg value="../../${final.name}.tar.gz"/>
</exec>
Copy link
Copy Markdown
Member

@imbajin imbajin Dec 16, 2023

Choose a reason for hiding this comment

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

Description: due to we already have the release script in dist module, we don't need cp the pkg now

procps \
curl \
lsof \
vim \
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

TODO: consider replace with nano or use a more slime way to install it

@simon824 simon824 merged commit cb4427d into apache:master Dec 17, 2023
VGalaxies pushed a commit to VGalaxies/incubator-hugegraph that referenced this pull request Jan 12, 2024
* fix(dist): update relative path for the 1.2.0

* add docker policy and run server in daemon

* fix: use tail to avoid container exit

* adjuest the order of quick start

* Update hugegraph-server/hugegraph-dist/docker/scripts/detect-storage.groovy

* adjust desc

* Update README.md

* Update pom.xml

---------

Co-authored-by: imbajin <[email protected]>
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.

4 participants