Google Git
Sign in
apache / incubator-pegasus-website / 6db633fcfb9ae4d12c6875d4b8ef7feabfb95846
commit6db633fcfb9ae4d12c6875d4b8ef7feabfb95846[log] [tgz]
authorSamunroyu <yujingweiop@gmail.com>Sun Nov 16 22:11:18 2025 +0800
committerGitHub <noreply@github.com>Sun Nov 16 22:11:18 2025 +0800
tree42606d1034532d04614d6a92714552ce8548f338
parent3faf58c077bfa6b0b13e8d9462dd424dc9e8a7a5 [diff]
update node client doc (#125)
2 files changed
tree: 42606d1034532d04614d6a92714552ce8548f338
  1. .github/
  2. _community/
  3. _data/
  4. _docs/
  5. _includes/
  6. _layouts/
  7. _overview/
  8. _posts/
  9. _sass/
  10. assets/
  11. node_modules/
  12. .asf.yaml
  13. .gitignore
  14. 404.html
  15. _config.yml
  16. blogs.md
  17. Gemfile
  18. index.md
  19. License.Apache2
  20. License.MIT
  21. package-lock.json
  22. README.md
README.md

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: http://127.0.0.1:4000
  Server running... press ctrl-c to stop.

Then open your browser and visit http://127.0.0.1:4000

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!