acelyc111 opened a new issue, #1712:
URL: https://github.com/apache/incubator-pegasus/issues/1712

   # Background
   The Pegasus website (https://pegasus.apache.org) is not well maintenanced 
for a period of time, some of the documents are out of date, some new features 
are not mentioned or described how to use, lack a lot of English documents, 
some links are broken, some pages are not well rendered, etc.
   Pegasus is an excellent distributed key-value store, it's a basic work to 
improve and perfect the website to make more users know how it works and how to 
use it.
   
   # Who can countribute?
   Anybody!
   Any volunteer is recruited and encouraged to improve any big or small 
imprvoments of the website!
   
   # How to countribute?
   [The website](https://pegasus.apache.org) is a static website based on 
[Jekyll](https://jekyllrb.com/), and almost all of the documents are wrote in 
Markdown.
   - Documents: It's a bit of easy to improve the documents as long as you know 
Markdown.
   - Website: If you are familiar to static website frontend(basic HTML, CSS, 
JavaScript), you can help to improve the website layout, rendering, etc.
   
   Now you can start with:
   1. Fork the website Github repository
   <img width="1617" alt="image" 
src="https://github.com/apache/incubator-pegasus/assets/10775040/912d46de-a707-4e8d-a96f-4a01c4e73e3a";>
   2. Git clone the code of the repository you just forked.
   ```
   git clone [email protected]:<you_github_id>/incubator-pegasus-website.git
   ```
   3. Find a task in the following list, or create a new task if you want.
   4. Write the code to complete the task in your local workspace.
   5. Check if it works as expect:
   Simply, in you local workspace
   ```
   $ bundle exec jekyll serve
   ...
    Auto-regeneration: enabled for 
'/Users/laiyingchun/dev/incubator-pegasus-website'
       Server address: http://127.0.0.1:4000
     Server running... press ctrl-c to stop.
   ```
   You can preview the result by opening `http://127.0.0.1:4000` in you browser.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to