Google Git
Sign in
apache / cloudberry-site

Website sources for Apache Cloudberry™️ (Incubating)

Mirrored from https://github.com/apache/cloudberry-site.git
Clone this repo:

Branches

  1. cfda795 Add asf-staging as protected branch by Dianjin Wang · 2 days ago main
  2. 93aadc6 Update the name and URLs in Bootcamp by Dianjin Wang · 7 days ago
  3. eabf9b4 Update security links by Dianjin Wang · 7 days ago
  4. 8b2292a Rename the name and remove the old zh translation by Dianjin Wang · 8 days ago
  5. 1bff351 Rename and clean unnecessary files for pages by Dianjin Wang · 8 days ago

Apache Cloudberry (Incubating) Website & Documentation

Website Documentation Slack Twitter Follow WeChat Youtube

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, 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
  1. Install dependencies

Before building the website, you need to install dependencies to make sure no errors when building.

$ npm install
  1. 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.

  1. (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).