Apache Cloudberry (Incubating) Website & Documentation

Website Directory Structure

.
├── LICENSE
├── NOTICE
├── README.md
├── babel.config.js
├── blog
├── docs
├── docusaurus.config.ts
├── global.d.ts
├── 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) 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, a modern static website generator. If you don't know Docusaurus, please learn more from Docusaurus website.

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. Initialize submodules (required for PXF documentation)

This repository uses git submodules to include PXF documentation. After cloning, run:

$ git submodule update --init --recursive
$ ./scripts/setup-pxf-submodule.sh

The setup script configures sparse checkout to only include the docs/ directory from the PXF submodule.

4. 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, you can submit the pull request here.

License

Apache License Version 2.0 (see LICENSE & NOTICE).