https://github.com/apache/cloudberry-site
Website sources for Apache Cloudberry™️ (Incubating)
https://github.com/apache/cloudberry-site
cloudberry database docusaurus greenplum postgresql
Last synced: 3 months ago
JSON representation
Website sources for Apache Cloudberry™️ (Incubating)
- Host: GitHub
- URL: https://github.com/apache/cloudberry-site
- Owner: apache
- License: apache-2.0
- Created: 2023-05-12T04:05:16.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-07-07T02:18:40.000Z (3 months ago)
- Last Synced: 2025-07-08T02:05:09.470Z (3 months ago)
- Topics: cloudberry, database, docusaurus, greenplum, postgresql
- Language: TypeScript
- Homepage: https://cloudberry.apache.org
- Size: 612 MB
- Stars: 16
- Watchers: 14
- Forks: 33
- Open Issues: 38
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: docs/security/client-auth.md
Awesome Lists containing this project
README
## Apache Cloudberry (Incubating) Website & Documentation
[](https://cloudberry.apache.org)
[](https://cloudberry.apache.org/docs)
[](https://inviter.co/apache-cloudberry)
[](https://twitter.com/ASFCloudberry)
[](https://cloudberry.apache.org/community/wechat)
[](https://youtube.com/@ApacheCloudberry)
---
## Website Directory Structure
```
.
├── LICENSE
├── NOTICE
├── README.md
├── babel.config.js
├── blog
├── docs
├── docusaurus.config.ts
├── global.d.ts
├── i18n
├── package-lock.json
├── package.json
├── scripts
├── sidebars.ts
├── src
├── static
└── tsconfig.json
```
Notable directories Description:
1. Blog
The Blog post files are placed in the `blog` directory. You need
to create one new folder for each new post and add the author
information to the `blog/authors.yml`.
2. Document
The latest version of the document is under the `docs` (en) and
`/i18n/zh/docusaurus-plugin-content-docs/current/` (zh).
directory. Media including images, video can be placed in
`docs/media` folder. You must add the new doc file name to
`sidebars.js` to make it display on the website.
3. Pictures
All images are placed in the `static/img` directory.
## Website Building
This website is built using [Docusaurus 3](https://docusaurus.io/), a
modern static website generator. If you don't know Docusaurus, please
learn more from [Docusaurus website](https://docusaurus.io/).
You can follow these steps to install and build the Apache Cloudberry
website in your local environment.
1. Clone website source
```
$ git clone https://github.com/apache/cloudberry-site.git
```
2. Install dependencies
Before building the website, you need to install dependencies to make
sure no errors when building.
```
$ npm install
```
3. Build and run
```
$ npm run build
$ npm run serve
```
This command generates static content into the `build` directory and
can be served using any static contents hosting service.
Then you can visit `localhost:3000` in the browser.
4. (Option) If you want to run the local development environment, you
can skip Step 3 to run the following command directly:
```
$ npm run start
```
This command starts a local development server and opens up a browser
window. Most changes are reflected live without having to restart the
server.
## Document Contribution
Our documents are still in construction, welcome to help. If you're
interested in [document
contribution](https://cloudberry.apache.org/community/docs-contributing-guide),
you can submit the pull request
[here](https://github.com/apache/cloudberry-site/tree/main/docs).
# License
Apache License Version 2.0 (see LICENSE & NOTICE).