Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve Pegasus website #1712

Open
acelyc111 opened this issue Dec 6, 2023 · 1 comment
Open

Improve Pegasus website #1712

acelyc111 opened this issue Dec 6, 2023 · 1 comment

Comments

@acelyc111
Copy link
Member

acelyc111 commented Dec 6, 2023 •
edited
Loading

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.

NOTE: The codebase of the website is https://github.com/apache/incubator-pegasus-website, which is separated from https://github.com/apache/incubator-pegasus.

Who can countribute?

Anybody!
Any volunteer is recruited and encouraged to improve any big or small imprvoments of the website!
Don't hesitate to assign the following task to yourself.

How to countribute?

The website is a static website based on Jekyll, 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, multiple version management, etc.

Now you can start with:

  1. Fork the website Github repository
image
  1. Git clone the code of the repository you just forked.
git clone [email protected]:<you_github_id>/incubator-pegasus-website.git

  1. Find a task in the following list, or create a new task if you want.

  2. Write the code to complete the task in your local workspace.

  3. Check if it works as expect:

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

Then, 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.

  1. Submit the patch as a pullrequest

  2. The project managers will review the pullrequest soon, and will merge the PR if there is no problem.
@acelyc111
Copy link
Member Author

acelyc111 commented Dec 6, 2023 •
edited
Loading

Tasks

Feel free to leave a message in the task link if you want to assign it to yourself.

Translating

It's recommand to update the Chinese docs at first (if necessary), then translate it to English.

Website

  • Upgrade the framework
  • Improve the UI/UE
  • Adapt both desktop and mobile devices
  • You can add more tasks

Others

  • You can add more tasks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@acelyc111