Skip to content

Latest commit

 

History

History
79 lines (52 loc) · 2.7 KB

README.md

File metadata and controls

79 lines (52 loc) · 2.7 KB

Apache CarbonData Official Website

This project keeps all sources used for building up CarbonData official website which is served at https://CarbonData.apache.org/.

Prerequisite

CarbonData website is powered by docsite.

Please also make sure your node version is 10+, version lower than 10.x is not supported yet.

Build instruction

  1. Run npm install in the root directory to install the dependencies.
  2. If you want to debug zh website, you can run npm run start in the root directory to start a local server, you will see the website in 'http://127.0.0.1:8080'.
  3. Run npm run build to build source code into dist directory.
  4. If you want to view all website, you can run npm install http-server -g, then run http-server ./dist in the root directory.

If you have higher version of node installed, you may consider nvm to allow different versions of node coexisting on your machine.

  1. Follow the instructions to install nvm
  2. Run nvm install v10.23.1 to install node v10
  3. Run nvm use v10.23.1 to switch the working environment to node v10

Then you are all set to run and build the website. Follow the build instruction above for the details.

Website update

  1. Edit markdown files
  2. Commit & push to github
  3. The website will update automatically by github action

How to send a PR

  1. Do not use git add . to commit all the changes.
  2. Just push your changed files, such as:
    • *.md
    • blog.js or docs.js or site.js
  3. Send a PR to master branch.

SEO

Make sure each .md starts with the following texts:

---
title: title
keywords: keywords1,keywords2, keywords3
description: some description
---

Guide for adding a new document

Add a new blog

  1. Add new .md file under blog/zh-cn or blog/zh-cn.
  2. Update site_config/blog.js, add a new entry to the blog in either zh-cn or zh-cn.
  3. Run docsite start locally to verify the blog can be displayed correctly.
  4. Send the pull request contains the .md and blog.js only.

Add a new article for development

  1. Add new .md file under docs/zh-cn/development or docs/zh-cn/development.
  2. Update site_config/development.js, add a new entry in either zh-cn or zh-cn.
  3. Run docsite start locally to verify the article can be displayed correctly.
  4. Send the pull request contains the *.md and development.js only.

Add a new article for docs

  1. Add new .md file under docs/zh-cn or docs/zh-cn.
  2. Update site_config/docs.js, add a new entry in either zh-cn or zh-cn.
  3. Run docsite start locally to verify the article can be displayed correctly.
  4. Send the pull request contains the *.md and development.js only.

Best Regards.
Thanks for reading :)