Apache Pegasus Website

Clone this repo:
  1. 2d9a667 Update remote-commands docs (#85) by Yingchun Lai · 4 weeks ago master
  2. c1d55ff Update table-envs docs (#84) by Yingchun Lai · 4 weeks ago
  3. 5de8507 Update HTTP docs (#83) by Yingchun Lai · 6 weeks ago
  4. d71c884 Update config docs (#82) by Yingchun Lai · 9 weeks ago
  5. 72090ea Update docs index (#81) by Yingchun Lai · 10 weeks ago

This is the website codebase of the Apache Pegasus project.

It is a static website based on Jekyll, and almost all the documents are written in Markdown.

If you found any mistake on the website, or you've developed a new feature for the Pegasus project, or you want to improve the UI/UE of the website, you are encouraged to update the website.

How to contribute

How to preview the website

Install Jekyll at first https://jekyllrb.com/docs/

$ git clone git@github.com:apache/incubator-pegasus-website.git
$ cd incubator-pegasus-website
$ bundle exec jekyll serve
 Auto-regeneration: enabled for '.../incubator-pegasus-website'
    Server address:
  Server running... press ctrl-c to stop.

Then open your browser and visit

Submit your changes

  1. Update the website codebase, and preview it locally to check it act as expected.

If you want to update or draw a new diagram, you can use draw.io and open assets/drawio/apache_pegasus_website.drawio to draw it, and save it as a .png file, then put it into the assets/images directory. Remember to submit the changed .drawio file together with the .png file.

  1. Submit the patch as a pull request

  2. Wait the project committers to review and merge your patch.

View on the website

Open your browser and visit https://pegasus.apache.org/, you will see the result of your patch.

Enjoy it!