Skip to content

Commit 1f40f05

Browse files
authored
doc: add comment for historical package names (#2970)
1 parent 5578b79 commit 1f40f05

5 files changed

Lines changed: 36 additions & 20 deletions

File tree

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -223,9 +223,17 @@ Download pre-built packages from the [Download Page](https://hugegraph.apache.or
223223

224224
```bash
225225
# Download and extract
226-
wget https://downloads.apache.org/hugegraph/{version}/apache-hugegraph-{version}.tar.gz
227-
tar -xzf apache-hugegraph-{version}.tar.gz
228-
cd apache-hugegraph-{version}
226+
# For historical 1.7.0 and earlier releases, use the archive URL and
227+
# set PACKAGE=apache-hugegraph-incubating-{version} instead.
228+
BASE_URL="https://downloads.apache.org/hugegraph/{version}"
229+
PACKAGE="apache-hugegraph-{version}"
230+
# Historical alternative:
231+
# BASE_URL="https://archive.apache.org/dist/incubator/hugegraph/{version}"
232+
# PACKAGE="apache-hugegraph-incubating-{version}"
233+
234+
wget ${BASE_URL}/${PACKAGE}.tar.gz
235+
tar -xzf ${PACKAGE}.tar.gz
236+
cd ${PACKAGE}
229237

230238
# Initialize backend storage
231239
bin/init-store.sh

hugegraph-store/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,12 +104,12 @@ From the project root:
104104
mvn install -pl hugegraph-struct -am -DskipTests
105105

106106
# Build Store and all dependencies
107-
mvn clean package -pl hugegraph-store/hugegraph-store-dist -am -DskipTests
107+
mvn clean package -pl hugegraph-store/hg-store-dist -am -DskipTests
108108
```
109109

110110
The assembled distribution will be available at:
111111
```
112-
hugegraph-store/apache-hugegraph-store-1.7.0/lib/hg-store-node-1.7.0.jar
112+
hugegraph-store/apache-hugegraph-store-<version>/lib/hg-store-node-<version>.jar
113113
```
114114

115115
### Configuration
@@ -214,6 +214,8 @@ Start the Store server:
214214

215215
```bash
216216
# Replace {version} with your hugegraph version
217+
# For historical 1.7.0 and earlier releases, use
218+
# apache-hugegraph-store-incubating-{version} instead.
217219
cd apache-hugegraph-store-{version}
218220
219221
# Start Store node

hugegraph-store/docs/deployment-guide.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -416,8 +416,9 @@ df -h
416416

417417
```bash
418418
# Extract PD distribution
419-
tar -xzf apache-hugegraph-pd-1.7.0.tar.gz
420-
cd apache-hugegraph-pd-1.7.0
419+
# Note: use "-incubating" only for historical 1.7.0 and earlier package/directory names.
420+
tar -xzf apache-hugegraph-pd-incubating-1.7.0.tar.gz
421+
cd apache-hugegraph-pd-incubating-1.7.0
421422
422423
# Edit configuration
423424
vi conf/application.yml
@@ -509,8 +510,9 @@ curl http://192.168.1.10:8620/v1/members
509510

510511
```bash
511512
# Extract Store distribution
512-
tar -xzf apache-hugegraph-store-1.7.0.tar.gz
513-
cd apache-hugegraph-store-1.7.0
513+
# Note: use "-incubating" only for historical 1.7.0 and earlier package/directory names.
514+
tar -xzf apache-hugegraph-store-incubating-1.7.0.tar.gz
515+
cd apache-hugegraph-store-incubating-1.7.0
514516
515517
# Edit configuration
516518
vi conf/application.yml
@@ -626,8 +628,9 @@ curl http://192.168.1.10:8620/v1/stores
626628

627629
```bash
628630
# Extract Server distribution
629-
tar -xzf apache-hugegraph-1.7.0.tar.gz
630-
cd apache-hugegraph-1.7.0
631+
# Note: use "-incubating" only for historical 1.7.0 and earlier package/directory names.
632+
tar -xzf apache-hugegraph-incubating-1.7.0.tar.gz
633+
cd apache-hugegraph-incubating-1.7.0
631634
632635
# Configure backend
633636
vi conf/graphs/hugegraph.properties

hugegraph-store/docs/development-guide.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ git checkout 1.7-rebase
5858
2. Add new "Application" configuration:
5959
- Main class: `org.apache.hugegraph.store.node.StoreNodeApplication`
6060
- VM options: `-Xms4g -Xmx4g -Dconfig.file=conf/application.yml`
61-
- Working directory: `hugegraph-store/apache-hugegraph-store-1.7.0`
61+
- Working directory: `hugegraph-store/apache-hugegraph-store-<version>` (`apache-hugegraph-store-incubating-<version>` for historical 1.7.0 and earlier directories)
6262
- Use classpath of module: `hg-store-node`
6363

6464
### Build from Source
@@ -216,7 +216,9 @@ hg-store-grpc/
216216

217217
**Start Server**:
218218
```bash
219-
cd hugegraph-store/apache-hugegraph-store-1.7.0
219+
# Historical 1.7.0 and earlier directories use
220+
# apache-hugegraph-store-incubating-<version> instead.
221+
cd hugegraph-store/apache-hugegraph-store-<version>
220222
bin/start-hugegraph-store.sh
221223
```
222224

hugegraph-store/docs/operations-guide.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -593,8 +593,9 @@ curl http://192.168.1.10:8620/v1/partitionsAndStatus
593593
1. **Deploy New Store Node**:
594594
```bash
595595
# Follow deployment guide
596-
tar -xzf apache-hugegraph-store-1.7.0.tar.gz
597-
cd apache-hugegraph-store-1.7.0
596+
# Historical 1.7.0 packages still include the "-incubating" suffix
597+
tar -xzf apache-hugegraph-store-incubating-1.7.0.tar.gz
598+
cd apache-hugegraph-store-incubating-1.7.0
598599
599600
# Configure and start
600601
vi conf/application.yml
@@ -670,14 +671,14 @@ curl http://192.168.1.10:8620/v1/partitionsAndStatus
670671
bin/stop-hugegraph-store.sh
671672
672673
# Backup current version
673-
mv apache-hugegraph-store-1.7.0 apache-hugegraph-store-1.7.0-backup
674+
mv apache-hugegraph-store-incubating-1.7.0 apache-hugegraph-store-incubating-1.7.0-backup
674675
675-
# Extract new version
676+
# Extract new version (newer releases no longer include "-incubating")
676677
tar -xzf apache-hugegraph-store-1.8.0.tar.gz
677678
cd apache-hugegraph-store-1.8.0
678679
679680
# Copy configuration from backup
680-
cp ../apache-hugegraph-store-1.7.0-backup/conf/application.yml conf/
681+
cp ../apache-hugegraph-store-incubating-1.7.0-backup/conf/application.yml conf/
681682
682683
# Start new version
683684
bin/start-hugegraph-store.sh
@@ -715,8 +716,8 @@ bin/stop-hugegraph-store.sh
715716
716717
# Restore backup
717718
rm -rf apache-hugegraph-store-1.8.0
718-
mv apache-hugegraph-store-1.7.0-backup apache-hugegraph-store-1.7.0
719-
cd apache-hugegraph-store-1.7.0
719+
mv apache-hugegraph-store-incubating-1.7.0-backup apache-hugegraph-store-incubating-1.7.0
720+
cd apache-hugegraph-store-incubating-1.7.0
720721
721722
# Restart old version
722723
bin/start-hugegraph-store.sh

0 commit comments

Comments
 (0)