chore: improve the UI & content in README #2227
Conversation
README.md
Outdated
| ## ⏰ Contributor Over Time | ||
|
|
||
| [](https://git-contributor.com?chart=contributorOverTime&repo=apache/incubator-hugegraph) | ||
|
|
||
| ## 👍 Stargazers Over Time | ||
|
|
||
|  |
There was a problem hiding this comment.
Thanks, consider add the 2 charts in website/doc repo first? (statistic info could enhance later)
There was a problem hiding this comment.
I think it is reconcilable, put the 2 charts in the readme will be faster, the official website update is slower
There was a problem hiding this comment.
I want to upgrdae the hugegraph website with a new freamwork, the 2 charts can consider to put in new website. I am working for task 11
There was a problem hiding this comment.
I think it is reconcilable, put the 2 charts in the readme will be faster, the official website update is slower
yep, but maybe we need listen the community voice (like a vote in discussion to choose what kind of chart we need show in the README), because it occupies a larger space
There was a problem hiding this comment.
I create a new discussion for this question.We can discuss this question in this discussion with the community.
There was a problem hiding this comment.
@imbajin I delete these two controversial charts. After the community has conclusions, you can add it as according to the discussion. Do you think this is okay?
Codecov Report
@@ Coverage Diff @@
## master #2227 +/- ##
============================================
- Coverage 65.03% 64.97% -0.07%
+ Complexity 977 484 -493
============================================
Files 498 498
Lines 40681 40681
Branches 5681 5681
============================================
- Hits 26457 26432 -25
- Misses 11597 11605 +8
- Partials 2627 2644 +17 see 91 files with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
README.md
Outdated
|
|
||
| HugeGraph relies on the [TinkerPop](http://tinkerpop.apache.org) framework, we refer to the storage structure of Titan and the schema definition of DataStax. | ||
| Thanks to TinkerPop, thanks to Titan, thanks to DataStax. Thanks to all other organizations or authors who contributed to the project. | ||
|
|
||
| You are welcome to contribute to HugeGraph, and we are looking forward to working with you to build an excellent open source community. | ||
|
|
||
| ### Contact Us | ||
| [](https://github.com/apache/incubator-hugegraph/graphs/contributors) |
There was a problem hiding this comment.
wonder to know if we could reduce the size of this contri-graph? (like 50%?)
There was a problem hiding this comment.
yes, I change the size to take more small space
There was a problem hiding this comment.
I try it,but it seems too narrow，what do you think？What size it should be, normal size or small size ?
There was a problem hiding this comment.
I try it,but it seems too narrow，what do you think？What size it should be, normal size or small size ?
if we can't choose middle/proper size, seems the normal size is better
README.md
Outdated
| <div align="center"> | ||
| <img src="https://github.com/apache/incubator-hugegraph-doc/blob/master/assets/images/wechat.png?raw=true" alt="QR png" width="300"/> | ||
| </div> |
There was a problem hiding this comment.
seems the pic need move left for some space (middle of the section or just leave it with left side)
There was a problem hiding this comment.
I leave it with left side
|
Add the way to join slack and discord ? |
later (we need discuss & prepare for it first) 🔢 |
README.md
Outdated
|
|
||
| </div> | ||
|
|
||
| ## 🚀 What is Apache HugeGraph? |
There was a problem hiding this comment.
the icon doesn't seem to be able to accurately express the meaning, we would rather remove it, the same below (until "Contributing").
There was a problem hiding this comment.
OK, I will remove all icon to keep same style.
imbajin
changed the title
|
we could also enhance other huge repos later~ (with same enhancement) 🔢 |
Improve HugeGraph Readme
Change logo img to no-background, which can use in dark theme; and change logo img size to narrow size, which take up less space.
Put the introduction at the top of the readme to briefly explain hugegraph
Fix hugegraph codecov link and img link to correct
Add stars img after downloads count
Add icons for all title
Add contribution img to thanks all hugegraph contributors
Add Contributor Over Time and Stargazers Over Time to explain the product contribution and star process