Skip to content

chore: improve the UI & content in README#2227

Merged
imbajin merged 17 commits intoapache:masterfrom
lionztt:feature-upgrade-hugegraph-readme
Jun 12, 2023
Merged

chore: improve the UI & content in README#2227
imbajin merged 17 commits intoapache:masterfrom
lionztt:feature-upgrade-hugegraph-readme

Conversation

@lionztt
Copy link
Copy Markdown
Contributor

@lionztt lionztt commented Jun 6, 2023

Improve HugeGraph Readme

  1. 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.
    149281100-c296db08-2861-4174-a31f-e2a92ebeeb72__2_-removebg

  2. Put the introduction at the top of the readme to briefly explain hugegraph

  3. Fix hugegraph codecov link and img link to correct Codecov

  4. Add stars img after downloads count stars

  5. Add icons for all title

  6. Add contribution img to thanks all hugegraph contributors

  7. Add Contributor Over Time and Stargazers Over Time to explain the product contribution and star process

README.md Outdated
Comment on lines +70 to +76
## ⏰ Contributor Over Time

[![Stargazers Over Time](https://contributor-overtime-api.git-contributor.com/contributors-svg?chart=contributorOverTime&repo=apache/incubator-hugegraph)](https://git-contributor.com?chart=contributorOverTime&repo=apache/incubator-hugegraph)

## 👍 Stargazers Over Time

![Stargazers over time](https://api.star-history.com/svg?repos=apache/incubator-hugegraph&type=Date)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, consider add the 2 charts in website/doc repo first? (statistic info could enhance later)

Copy link
Copy Markdown
Contributor Author

@lionztt lionztt Jun 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is reconcilable, put the 2 charts in the readme will be faster, the official website update is slower

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I create a new discussion for this question.We can discuss this question in this discussion with the community.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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
Copy link
Copy Markdown

codecov bot commented Jun 6, 2023

Codecov Report

Merging #2227 (ff52f2f) into master (bcf2a39) will decrease coverage by 0.07%.
The diff coverage is n/a.

@@             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
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
[![contributors graph](https://contrib.rocks/image?repo=apache/hugegraph)](https://github.com/apache/incubator-hugegraph/graphs/contributors)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wonder to know if we could reduce the size of this contri-graph? (like 50%?)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, I change the size to take more small space

Copy link
Copy Markdown
Contributor Author

@lionztt lionztt Jun 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I try it,but it seems too narrow,what do you think?What size it should be, normal size or small size ?
image

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I try it,but it seems too narrow,what do you think?What size it should be, normal size or small size ? image

if we can't choose middle/proper size, seems the normal size is better

README.md Outdated
Comment on lines +86 to +88
<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>
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

seems the pic need move left for some space (middle of the section or just leave it with left side)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I leave it with left side

@simon824
Copy link
Copy Markdown
Member

Add the way to join slack and discord ?

@imbajin
Copy link
Copy Markdown
Member

imbajin commented Jun 12, 2023

Add the way to join slack and discord ?

later (we need discuss & prepare for it first) 🔢

README.md Outdated

</div>

## 🚀 What is Apache HugeGraph?
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the icon doesn't seem to be able to accurately express the meaning, we would rather remove it, the same below (until "Contributing").

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, I will remove all icon to keep same style.

Copy link
Copy Markdown
Member

@imbajin imbajin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Copy Markdown
Contributor

@javeme javeme left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@imbajin imbajin changed the title feat: Improve HugeGraph Readme chore: improve the UI & content in README Jun 12, 2023
@imbajin imbajin merged commit b836426 into apache:master Jun 12, 2023
@imbajin
Copy link
Copy Markdown
Member

imbajin commented Jun 12, 2023

we could also enhance other huge repos later~ (with same enhancement) 🔢

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

4 participants