Skip to content

Commit 188cc1d

Browse files
tuhaihetuhaihe
committed
Doc: update the README.md
Update the description and information in README.md to give everyone a better understanding of the Cloudberry Database.
1 parent 143b3df commit 188cc1d

1 file changed

Lines changed: 66 additions & 103 deletions

File tree

‎README.md‎

Lines changed: 66 additions & 103 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,12 @@
1010
Next Generation Unified Database for Analytics and AI
1111
</p>
1212

13+
[![Website](https://img.shields.io/badge/Website-eebc46)](https://cloudberrydb.org)
14+
[![Documentation](https://img.shields.io/badge/Documentation-acd94a)](https://cloudberrydb.org/docs)
1315
[![Slack](https://img.shields.io/badge/Join_Slack-6a32c9)](https://communityinviter.com/apps/cloudberrydb/welcome)
1416
[![Twitter Follow](https://img.shields.io/twitter/follow/cloudberrydb)](https://twitter.com/cloudberrydb)
1517
[![WeChat](https://img.shields.io/badge/WeChat-eebc46)](https://cloudberrydb.org/community/wechat)
1618
[![Youtube](https://img.shields.io/badge/Youtube-gebc46)](https://youtube.com/@cloudberrydb)
17-
[![Website](https://img.shields.io/badge/Visit%20Website-eebc46)](https://cloudberrydb.org)
1819
[![GitHub Discussions](https://img.shields.io/github/discussions/cloudberrydb/cloudberrydb)](https://github.com/orgs/cloudberrydb/discussions)
1920
![GitHub commit activity(branch)](https://img.shields.io/github/commit-activity/m/cloudberrydb/cloudberrydb)
2021
![GitHub contributors](https://img.shields.io/github/contributors/cloudberrydb/cloudberrydb)
@@ -24,122 +25,54 @@
2425

2526
---------
2627

27-
Cloudberry Database (CBDB) is shipped with PostgreSQL 14.4 as its
28-
kernel and is forked from Greenplum Database 7, which serves as our
29-
code base.
28+
## What's Cloudberry Database
3029

31-
## Features
30+
Cloudberry Database (`CBDB` or `CloudberryDB` for short) is created by a bunch
31+
of original Greenplum Database developers and ASF committers. We aim to bring
32+
modern computing capabilities to the traditional distributed MPP database to
33+
support Analytics and AI/ML workloads in one platform.
3234

33-
Cloudberry Database is compatible with Greenplum, and provides all the
34-
Greenplum features you need. In addition, Cloudberry Database possesses some
35-
features that Greenplum currently lacks or does not support. Visit this
36-
[feature comparison doc](https://cloudberrydb.org/docs/cbdb-vs-gp-features)
37-
for details.
35+
As a derivative of Greenplum Database 7, Cloudberry Database is compatible
36+
with Greenplum Database, but it's shipped with a newer PostgreSQL 14.4 kernel
37+
(scheduled kernel upgrade yearly) and a bunch of features Greenplum Database
38+
lacks or does not support. View the [Cloudberry Database vs Greenplum
39+
Database](https://cloudberrydb.org/docs/cbdb-vs-gp-features) doc for details.
3840

39-
## Code layout
41+
## Roadmap
4042

41-
The directory layout of the repository follows the same general layout
42-
as upstream PostgreSQL. There are changes compared to PostgreSQL
43-
throughout the codebase, but a few larger additions worth noting:
43+
You can check our [Cloudberry Database Roadmap
44+
2024](https://github.com/orgs/cloudberrydb/discussions/369) out to see the
45+
product plans and goals we want to achieve in 2024. Welcome to share your
46+
thoughts and ideas to join us in shaping the future of the Cloudberry
47+
Database.
4448

45-
* __gpMgmt/__ : Contains CloudberryDB-specific command-line tools for
46-
managing the cluster. Scripts like gpinit, gpstart, and gpstop
47-
live here. They are mostly written in Python.
49+
## Build and try out
4850

49-
* __gpAux/__ : Contains CloudberryDB-specific release management
50-
scripts, and vendored dependencies. Some additional directories
51-
are submodules and will be made available over time.
51+
### Build from source
5252

53-
* __gpcontrib/__ : Much like the PostgreSQL contrib/ directory, this
54-
directory contains extensions such as gpfdist, PXF and gpmapreduce
55-
which are CloudberryDB-specific.
53+
You can follow [these guides](./readmes) to build the Cloudberry Database on
54+
Linux OS(including CentOS, RHEL/Rocky Linux, and Ubuntu) and macOS.
5655

57-
* __doc/__ : In PostgreSQL, the user manual lives here. In Cloudberry
58-
Database, the user manual is maintained separately at [Cloudberry
59-
Database Website
60-
Repo](https://github.com/cloudberrydb/cloudberrydb-site/tree/main).
56+
### Try out quickly
6157

62-
* __src/__
63-
64-
* __src/backend/cdb/__ : Contains larger CloudberryDB-specific
65-
backend modules. For example, communication between segments,
66-
turning plans into parallelizable plans, mirroring, distributed
67-
transaction and snapshot management, etc. __cdb__ stands for
68-
__Cluster Database__ - it was a workname used in the early
69-
days. That name is no longer used, but the __cdb__ prefix remains.
70-
71-
* __src/backend/gpopt/__ : Contains the so-called __translator__
72-
library, for using the GPORCA optimizer with Cloudberry
73-
Database. The translator library is written in C++ code, and
74-
contains glue code for translating plans and queries between the
75-
DXL format used by GPORCA, and the PostgreSQL internal
76-
representation.
77-
78-
* __src/backend/gporca/__ : Contains the GPORCA optimizer code and
79-
tests. This is written in C++. See
80-
[README.md](src/backend/gporca/README.md) for more information and
81-
how to unit-test GPORCA.
82-
83-
* __src/backend/fts/__ : FTS is a process that runs in the
84-
coordinator node, and periodically polls the segments to maintain
85-
the status of each segment.
86-
87-
## Building Cloudberry Database
88-
89-
You can follow [these guides](./readmes) to build the Cloudberry
90-
Database on Linux OS(including CentOS, RHEL, and Ubuntu) and macOS.
91-
92-
## Documentation
93-
94-
For Cloudberry Database documentation, please check the [documentation
95-
website](https://cloudberrydb.org/docs/). Our documents are still in
96-
construction, welcome to help. If you're interested in [document
97-
contribution](https://cloudberrydb.org/contribute/doc), you can submit
98-
the pull request
99-
[here](https://github.com/cloudberrydb/cloudberrydb-site/tree/main/docs).
100-
101-
We also recommend you take [PostgreSQL
102-
Documentation](https://www.postgresql.org/docs/) and [Greenplum
103-
Documentation](https://docs.vmware.com/en/VMware-Greenplum/6/greenplum-database/landing-index.html#differences-compared-to-open-source-greenplum-database)
104-
as quick references.
58+
Welcome to try out Cloudberry Database via building [one Docker-based
59+
Sandbox](https://github.com/cloudberrydb/bootcamp), which is tailored to help
60+
you gain a basic understanding of Cloudberry Database's capabilities and
61+
features a range of materials, including tutorials, sample code, and crash
62+
courses.
10563

10664
## Repositories
10765

10866
This is the main repository for Cloudberry Database. Alongside this, there are
10967
several ecosystem repositories for the Cloudberry Database, including the
11068
website, extensions, connectors, adapters, and other utilities.
11169

112-
* [cloudberrydb/cloudberrydb-site](https://github.com/cloudberrydb/cloudberrydb-site): website sources.
113-
* [bootcamp](https://github.com/cloudberrydb/bootcamp): help you quickly try out Cloudberry Database via one Docker-based Sandbox.
114-
* [gpbackup](https://github.com/cloudberrydb/gpbackup): backup utility for Cloudberry Database.
115-
* [gp-common-go-libs](https://github.com/cloudberrydb/gp-common-go-libs): gp-common-go-libs for Cloudberry Database.
70+
* [cloudberrydb/cloudberrydb-site](https://github.com/cloudberrydb/cloudberrydb-site): website and documentation sources.
71+
* [cloudberrydb/bootcamp](https://github.com/cloudberrydb/bootcamp): help you quickly try out Cloudberry Database via one Docker-based Sandbox.
72+
* [cloudberrydb/gpbackup](https://github.com/cloudberrydb/gpbackup): backup utility for Cloudberry Database.
73+
* [cloudberrydb/gp-common-go-libs](https://github.com/cloudberrydb/gp-common-go-libs): gp-common-go-libs for Cloudberry Database.
11674
* More is coming...
11775

118-
## Contribution
119-
120-
Cloudberry Database is maintained actively by a group of community
121-
database experts by individuals and companies. We believe in the
122-
Apache Way "Community Over Code" and we want to make Cloudberry
123-
Database a community-driven project.
124-
125-
Contributions can be diverse, such as code enhancements, bug fixes,
126-
feature proposals, documents, marketing, and so on. No contribution is
127-
too small, we encourage all types of contributions. Cloudberry
128-
Database community welcomes contributions from anyone, new and
129-
experienced! Our [contribution
130-
guide](https://cloudberrydb.org/contribute/how-to-contribute) will
131-
help you get started with the contribution.
132-
133-
| Type | Description |
134-
|----|---------------|
135-
| Code contribution | Learn how to contribute code to the Cloudberry Database, including coding preparation, conventions, workflow, review, and checklist following the [code contribution guide](https://cloudberrydb.org/contribute/code).|
136-
| Submit the proposal | Proposing major changes to Cloudberry Database through [proposal guide](https://cloudberrydb.org/contribute/proposal).|
137-
| Doc contribution | We need you to join us to help us improve the documentation, see the [doc contribution guide](https://cloudberrydb.org/contribute/doc).|
138-
139-
For better collaboration, it's important for developers to learn how
140-
to work well with Git and GitHub, see the guide ["Working with Git &
141-
GitHub"](https://cloudberrydb.org/contribute/git).
142-
14376
## Community & Support
14477

14578
We have many channels for community members to discuss, ask for help,
@@ -156,14 +89,44 @@ feedback, and chat:
15689
| Documentation | [Official documentation](https://cloudberrydb.org/docs/) for Cloudberry Database. You can explore it to discover more details about us. |
15790

15891
When you are involved, please follow our community [Code of
159-
Conduct](https://cloudberrydb.org/community/coc) to help create a safe
160-
space for everyone.
92+
Conduct](https://cloudberrydb.org/community/coc) to help create a safe space
93+
for everyone.
94+
95+
## Contribution
96+
97+
We believe in the Apache Way "Community Over Code" and we want to make
98+
Cloudberry Database a community-driven project.
99+
100+
Contributions can be diverse, such as code enhancements, bug fixes, feature
101+
proposals, documents, marketing, and so on. No contribution is too small, we
102+
encourage all types of contributions. Cloudberry Database community welcomes
103+
contributions from anyone, new and experienced! Our [contribution
104+
guide](https://cloudberrydb.org/contribute) will help you get started with the
105+
contribution.
106+
107+
| Type | Description |
108+
|----|---------------|
109+
| Code contribution | Learn how to contribute code to the Cloudberry Database, including coding preparation, conventions, workflow, review, and checklist following the [code contribution guide](https://cloudberrydb.org/contribute/code).|
110+
| Submit the proposal | Proposing major changes to Cloudberry Database through [proposal guide](https://cloudberrydb.org/contribute/proposal).|
111+
| Doc contribution | We need you to join us to help us improve the documentation, see the [doc contribution guide](https://cloudberrydb.org/contribute/doc).|
112+
113+
## Contributors Wall
114+
115+
Thanks to all the people who already contributed!
116+
117+
<a href="https://github.com/cloudberrydb/cloudberrydb/graphs/contributors">
118+
<img src="https://contrib.rocks/image?repo=cloudberrydb/cloudberrydb&max=800&columns=20&anon=0" />
119+
</a>
120+
121+
<sub>Please note that the images shown above highlight the avatars of our
122+
active and upstream contributors while not including anonymous
123+
contributors. To view all the contributors, you can click on the images.</sub>
161124

162125
## Acknowledgment
163126

164127
Thanks to [PostgreSQL](https://www.postgresql.org/), [Greenplum
165-
Database](https://greenplum.org/) and other great open source projects
166-
to make Cloudberry Database has a sound foundation.
128+
Database](https://greenplum.org/) and other great open source projects to make
129+
Cloudberry Database has a sound foundation.
167130

168131
## License
169132

0 commit comments

Comments
 (0)