Skip to content

Commit 8ba10ab

Browse files
committed
Cleanup the build tools and guide directories
In this PR, we have some changes for the build guides and deploy tools. Including: - Rename `readmes/*` -> `deploy/build/*` - Rename `hooks/*` -> `src/tools/hooks/*` - Move `python-dependencies.txt` to the top dir - Move `README.Conda.md` out from the main repo to the `cloudberrydb/cloudberrydb-site` repo because it's for the data analytics guide, not how to build a Cloudberry Database. Note that we have not verified the files in `deploy/vagrant`, `deploy/docker`, and `deploy/k8s`. We cannot make sure it can run successfully. We will do that in the following months.
1 parent 6b5c6a2 commit 8ba10ab

26 files changed

+13
-93
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Database.
5050

5151
### Build from source
5252

53-
You can follow [these guides](./readmes) to build the Cloudberry Database on
53+
You can follow [these guides](./deploy/build) to build the Cloudberry Database on
5454
Linux OS(including CentOS, RHEL/Rocky Linux, and Ubuntu) and macOS.
5555

5656
### Try out quickly
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,10 @@ Enter the repository and install dependencies according to your operating system
3030

3131
The following steps work on CentOS 7. For other CentOS versions, these steps might work but are not guaranteed to work.
3232

33-
1. Run the bash script `README.CentOS.bash` in the `readmes` directory of the `cloudberrydb/cloudberrydb` repository. To run this script, password is required. Then, some required dependencies will be automatically downloaded.
33+
1. Run the bash script `README.CentOS.bash` in the `deploy/build` directory of the `cloudberrydb/cloudberrydb` repository. To run this script, password is required. Then, some required dependencies will be automatically downloaded.
3434

3535
```bash
36-
cd cloudberrydb/readmes
36+
cd cloudberrydb/deploy/build
3737
./README.CentOS.bash
3838
```
3939

@@ -81,16 +81,16 @@ The following steps work on CentOS 7. For other CentOS versions, these steps mig
8181
3. Install more dependencies by running the `README.Rhel-Rocky.bash` script.
8282

8383
```bash
84-
~/cloudberrydb/readmes/README.Rhel-Rocky.bash
84+
~/cloudberrydb/deploy/build/README.Rhel-Rocky.bash
8585
```
8686

8787
### For Ubuntu 18.04 or later
8888

89-
1. Install dependencies by running the `README.Ubuntu.bash` script in the `readmes` directory.
89+
1. Install dependencies by running the `README.Ubuntu.bash` script in the `deploy/build` directory.
9090

9191
```shell
9292
# You need to enter your password to run.
93-
sudo ~/cloudberrydb/readmes/README.Ubuntu.bash
93+
sudo ~/cloudberrydb/deploy/build/README.Ubuntu.bash
9494
```
9595

9696
> [!Note]
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ According to our test, these steps work well on macOS Ventura 13.4+ with both In
99
Run the following command to install the needed dependencies. You will be asked to enter the `sudo` password of your macOS system.
1010

1111
```bash
12-
source readmes/README.macOS.bash
12+
source deploy/build/README.macOS.bash
1313
```
1414

1515
> [!NOTE]
@@ -66,7 +66,7 @@ source $(cd ~; pwd)/install/cbdb/greenplum_path.sh
6666
6767
# 4. Install the Python dependencies.
6868
69-
pip3 install --user -r readmes/python-dependencies.txt
69+
pip3 install --user -r python-dependencies.txt
7070
7171
# 5. Start a demo cluster.
7272
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ Greenplum Database READE.md here. Thanks all the original writers.-->
55

66
This guides describes how to build Cloudberry Database from source code.
77

8-
- For building on Linux systems, see [Compile and Install Cloudberry Database on Linux](/readmes/README.Linux.md).
9-
- For building on macOS system, see [Compile and Install Cloudberry Database on macOS](/readmes/README.macOS.md).
8+
- For building on Linux systems, see [Compile and Install Cloudberry Database on Linux](./README.Linux.md).
9+
- For building on macOS system, see [Compile and Install Cloudberry Database on macOS](./README.macOS.md).
1010

1111
## Build the database
1212

@@ -98,7 +98,7 @@ make distclean
9898

9999
PXF is an extension framework for Greenplum Database/Cloudberry
100100
Database to enable fast access to external Hadoop datasets. Refer to
101-
[PXF extension](../gpcontrib/pxf/README.md) for more information.
101+
[PXF extension](../../gpcontrib/pxf_fdw/README.md) for more information.
102102

103103
Currently, CBDB is built with PXF by default (--enable-pxf is on).
104104
In order to build CBDB without pxf, simply invoke `./configure` with additional option `--disable-pxf`.
@@ -108,9 +108,9 @@ PXF requires curl, so `--enable-pxf` is not compatible with the `--without-libcu
108108

109109
Cloudberry Database supports Python3 with plpython3u UDF
110110

111-
See [how to enable Python3](../src/pl/plpython/README.md) for details.
111+
See [how to enable Python3](../../src/pl/plpython/README.md) for details.
112112

113113

114114
# Development with Vagrant
115115

116-
There is a Vagrant-based [quickstart guide for developers](../src/tools/vagrant/README.md).
116+
There is a Vagrant-based [quickstart guide for developers](../vagrant/README.md).
File renamed without changes.

0 commit comments

Comments
 (0)