https://github.com/apache/incubator-pegasus-website
Apache Pegasus Website
https://github.com/apache/incubator-pegasus-website
pegasus
Last synced: about 1 month ago
JSON representation
Apache Pegasus Website
- Host: GitHub
- URL: https://github.com/apache/incubator-pegasus-website
- Owner: apache
- License: apache-2.0
- Created: 2020-07-20T06:57:41.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2025-06-05T07:10:53.000Z (4 months ago)
- Last Synced: 2025-08-27T21:56:15.077Z (about 1 month ago)
- Topics: pegasus
- Language: HTML
- Homepage: https://pegasus.apache.org/
- Size: 30.8 MB
- Stars: 5
- Watchers: 6
- Forks: 17
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: License.Apache2
Awesome Lists containing this project
README
This is the [website](https://pegasus.apache.org/) codebase of the Apache [Pegasus](https://github.com/apache/incubator-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/
```bash
$ 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](https://app.diagrams.net/) and open [assets/drawio/apache_pegasus_website.drawio](./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.
2. Submit the patch as a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)
3. 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!