docs: add multiple new CHAOSS metrics (EN + ZH) #31

Neilblaze · 2024-08-01T20:07:46Z

Description

Added new CHAOSS metrics (both EN & ZH), for the following :

New Contributors
Change Request(s) Reviews
Change Requests Accepted
Change Requests Age
Change Requests Open
Change Requests Resolution Duration
Change Requests Response Time

[Update 11-09-24]: Refactored default views and added collapsibles.

🦄 Tested on local, build running successfully!

cc: @Peng99999, @frank-zsy / Partially resolves #24

Before submitting the PR, please take the following into consideration

It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. If you don't have an issue, please create one.
Prefix your PR title with feat: , fix: , chore: , docs:, or refactor:.
The description should clearly illustrate what problems it solves.
Ensure that the commit messages follow our guidelines.
Resolve merge conflicts (if any).
Make sure that the current branch is upto date with the main branch.

Signed-off-by: neilblaze <[email protected]>

frank-zsy · 2024-08-03T02:04:02Z

/preview

github-actions · 2024-08-03T02:07:25Z

🪧The website for this PR is deployed at https://open-digger.cn/pull_31/

frank-zsy · 2024-08-06T12:57:51Z

@Neilblaze Sorry that I have multiple lectures this week, I will come back to this PR later.

Neilblaze · 2024-08-07T19:11:20Z

Sounds good!

frank-zsy · 2024-08-16T08:08:12Z

I think it is really confusing to have so many metrics listed in a single category. Could we add another level to the metrics. Like:

OpenRank
Activity
General
- Stars
- Forks
Developers
- Active contributors
- New contributors
- Inactive contributors
- Activity dates and times
Issues
- Issues new
- Issues closed
- Issues age
- Issue comments
- Issue response time
- Issue resolution duration
Changes requests
- just like issue...

Do you think this will help users to understand?

Neilblaze · 2024-08-16T09:12:38Z

Do you think this will help users to understand?

@frank-zsy I had this concern while I was working on this, and you're right, we can surely optimize the view. But here's the catch, (prolly I'm nitpicking) if I do so, then the changes will be reflected holistically across the table, and since we're introducing a new column, a few rows shall remain empty, which I guess is fine 🤔 (or might look confusing, idk)

I'll need to reiterate the changes in a new commit and link it to this PR, so just in case the new one (new commit with all the updated changes) looks bad, we can just simply reject that one, & proceed with the parent commit (2377c79) itself.

Ref: #28 (comment)

frank-zsy · 2024-08-16T12:51:16Z

I think it's fine to make the change, actually I think we do not really need the table in introduction page after we have detailed metrics description in each page. We can remove the table and refer to metrics index page instead. WDYT

Neilblaze · 2024-08-16T13:05:22Z

I think it's fine to make the change, actually I think we do not really need the table in introduction page after we have detailed metrics description in each page. We can remove the table and refer to metrics index page instead. WDYT

Personally, I feel that the table is an important part of the entire docs ecosystem since it acts as an index to every metrics. But sure, we can remove that. Or what I propose is we can make it modular and keep each respective section (say, Activity, Developers, Issues, etc.) as subsections of the primary table itself, isolated into a collapsible component, like this 👇🏼

This should in fact represent the same data but in a more convenient order, saving spaces across the page. Thoughts?

frank-zsy · 2024-08-16T13:26:24Z

That looks really cool!

Signed-off-by: neilblaze <[email protected]>

frank-zsy · 2024-08-28T03:54:38Z

@Neilblaze Sorry, since I add a warning banner to preview deploy, I need to sync this PR with master branch but I miss operate with rebase rather than pull, so I need to force push back.

frank-zsy · 2024-08-28T03:54:44Z

/preview

github-actions · 2024-08-28T03:57:56Z

🪧The website for this PR is deployed at https://open-digger.cn/pull_31/

Neilblaze · 2024-08-29T19:40:41Z

@Neilblaze Sorry, since I add a warning banner to preview deploy, I need to sync this PR with master branch but I miss operate with rebase rather than pull, so I need to force push back.

No worries, I've pulled in the changes. It's on the work, I'll notify once I'm done with this :)

…gger into new-metrics-v2

Signed-off-by: neilblaze <[email protected]>

Neilblaze · 2024-09-11T18:06:30Z

/preview

github-actions · 2024-09-11T18:10:10Z

🪧The website for this PR is deployed at https://open-digger.cn/pull_31/

Neilblaze · 2024-09-11T18:34:54Z

@frank-zsy , @Peng99999 😎

We can get this one merged, while in the background I'll work on the EN variant, and will create a PR once I'm done with that 😄

Peng99999 · 2024-09-12T02:48:31Z

@frank-zsy , @Peng99999 😎

We can get this one merged, while in the background I'll work on the EN variant, and will create a PR once I'm done with that 😄

so cool！

Neilblaze · 2024-09-12T09:21:09Z

@frank-zsy just a heads up, I've noticed an overflow of text in the warning banner 👇🏼

frank-zsy · 2024-09-12T09:22:50Z

@frank-zsy just a heads up, I've noticed an overflow of text in the warning banner 👇🏼

Yes, thanks, the banner should consider mobile layout. Fortunately this is just a preview deploy for PRs, nothing will be affected in production. I will look into how to fix this.

frank-zsy · 2024-09-13T09:55:54Z

@Neilblaze So this PR contains English and Chinese version of new metrics along with the new README menu in Chinese version, am I right?

BTW, the banner height has been fixed.

Signed-off-by: neilblaze <[email protected]> Co-Authored-By: Frank Zhao <[email protected]>

Neilblaze · 2024-09-14T14:12:28Z

/preview

github-actions · 2024-09-14T14:15:39Z

🪧The website for this PR is deployed at https://open-digger.cn/pull_31/

Signed-off-by: neilblaze <[email protected]>

frank-zsy · 2024-09-16T08:15:53Z

In this PR, I would like to update the metrics structure in the intro part as follow:

OpenRank
- Repo global OpenRank
- Developer global OpenRank
- Repo community OpenRank
- Developer community OpenRank
Statistics
- Activity
- Stars
- Technical forks
- Attention
- Activity dates and times
Developers
- New contributors
- Contributors
- Inactive contributors
- Participants
- Bus factor
Issues
- Issues new
- Issues closed
- Issue comments
- Issue response time
- Issue resolution duration
- Issue age
Change requests
- Change requests
- Change requests accepted
- Change request reviews
- Change request response time
- Change request resolution duration
- Change request age
- Code change lines

In this structure, there will be only 5 top levels which will make the doc much cleaner.

Neilblaze · 2024-09-16T15:11:56Z

Cool, I'll make the changes

frank-zsy · 2024-09-17T00:56:19Z

@Neilblaze No worries, I will make the change and add new commit to this PR.

Neilblaze · 2024-09-17T03:03:28Z

@frank-zsy That'll be awesome, and thanks for the help! 😃
I feel the order (which you proposed) seems much better in terms of interpretability for anyone, be it a layman or an experienced user, so thanks again for the heads up!

Signed-off-by: frank-zsy <[email protected]>

frank-zsy · 2024-09-20T03:01:00Z

/preview

github-actions · 2024-09-20T03:04:19Z

🪧The website for this PR is deployed at https://open-digger.cn/pull_31/

Signed-off-by: frank-zsy <[email protected]>

frank-zsy · 2024-09-20T08:03:42Z

/preview

github-actions · 2024-09-20T08:07:02Z

🪧The website for this PR is deployed at https://open-digger.cn/pull_31/

Signed-off-by: frank-zsy <[email protected]>

frank-zsy · 2024-09-20T08:28:21Z

/preview

github-actions · 2024-09-20T08:31:57Z

🪧The website for this PR is deployed at https://open-digger.cn/pull_31/

Signed-off-by: frank-zsy <[email protected]>

frank-zsy · 2024-09-20T08:41:36Z

/preview

github-actions · 2024-09-20T08:44:58Z

🪧The website for this PR is deployed at https://open-digger.cn/pull_31/

frank-zsy · 2024-09-20T08:45:34Z

@Neilblaze I updated the intro doc and also the sidebar of docs part to fit the category. The categories are collapsed except OpenRank in intro doc and sidebar. Can you check the content and the links in the PR.

I think there are still some metrics missing related to issues and which from X-lab.

Neilblaze · 2024-09-20T12:53:38Z

@Neilblaze I updated the intro doc and also the sidebar of docs part to fit the category. The categories are collapsed except OpenRank in intro doc and sidebar. Can you check the content and the links in the PR.

Sure thing, I'll take a look and try to get things up and running. I'll also give a dry run for spell-check to ensure there's no typo.

I think there are still some metrics missing related to issues and which from X-lab.

Regarding the metrics related to issues, it's nearly done, and for the x-lab, I intentionally kept it on hold (till now), because I think it might require your guidance :)

I'm redirecting from this actually 😅

"Metrics from X-lab are almost complex metrics involves calculation or even graph data structure, so we can add them at last."

frank-zsy · 2024-09-20T13:33:04Z

@Neilblaze Yes, I will add the X-lab metrics. And actually issues and pull requests almost share the same metrics, we should manage how to present that.

Neilblaze · 2024-09-20T14:08:52Z

... actually issues and pull requests almost share the same metrics, we should manage how to present that.

@frank-zsy yes, I noticed that. One way can be multiplexing both under a common name and keeping individual info under that 🤔

I'll try to come up with something (better) in the meantime.

frank-zsy · 2024-09-21T03:24:45Z

I would like to merge this PR first and raise PRs if there is anything to modify later.

Signed-off-by: neilblaze <[email protected]>

Neilblaze · 2024-09-22T13:26:07Z

↪️ Continued in #45

Neilblaze added 2 commits July 21, 2024 15:12

docs: added new_contributors (metrics)

4bcb45d

Signed-off-by: neilblaze <[email protected]>

docs: added activity_details

2377c79

Signed-off-by: neilblaze <[email protected]>

Peng99999 mentioned this pull request Aug 14, 2024

OpenDigger Biweekly Meeting: 2024-08-14 X-lab2017/open-digger#1601

Closed

Neilblaze added 2 commits August 28, 2024 11:52

docs: added new_contributors (metrics)

0e946f6

Signed-off-by: neilblaze <[email protected]>

docs: added activity_details

47567e3

Signed-off-by: neilblaze <[email protected]>

frank-zsy force-pushed the new-metrics-v2 branch from 2377c79 to 47567e3 Compare August 28, 2024 03:53

Neilblaze added 4 commits September 9, 2024 16:37

Merge branch 'new-metrics-v2' of https://github.com/Neilblaze/open-di…

d686cd5

…gger into new-metrics-v2

[pull-changes]: latest → commit 4b4e1e6

50f7de1

Signed-off-by: neilblaze <[email protected]>

[refactor]: replaced table with collapsibles (ZH)

ba6a6da

Signed-off-by: neilblaze <[email protected]>

Merge branch 'master' into new-metrics-v2

91a6b70

[refactor]: added EN section for collapsibles

3b9b24c

Signed-off-by: neilblaze <[email protected]> Co-Authored-By: Frank Zhao <[email protected]>

[code]: beautified warning banner

37cbd7e

Signed-off-by: neilblaze <[email protected]>

refactor: reorder the metrics in intro.

b6769c5

Signed-off-by: frank-zsy <[email protected]>

frank-zsy added 2 commits September 20, 2024 11:39

fix: fix doc url

663698b

Signed-off-by: frank-zsy <[email protected]>

refactor: refactor the structure of metrics category

3f94d5a

Signed-off-by: frank-zsy <[email protected]>

refactor: add ref url for cr metrics in intro

84ae4cb

Signed-off-by: frank-zsy <[email protected]>

refactor: update polardb url

4dc6cc2

Signed-off-by: frank-zsy <[email protected]>

frank-zsy merged commit 59c9d7e into X-lab2017:master Sep 21, 2024
1 check passed

Neilblaze referenced this pull request in Neilblaze/open-digger Sep 22, 2024

[docs]: new-changes (content + refactorize)

aad5b8a

Signed-off-by: neilblaze <[email protected]>

frank-zsy mentioned this pull request Sep 23, 2024

[OSPP] Task:Building and improving user documentation and developer guides #24

Closed

docs: add multiple new CHAOSS metrics (EN + ZH) #31

docs: add multiple new CHAOSS metrics (EN + ZH) #31

Conversation

Neilblaze commented Aug 1, 2024 • edited Loading

Description

Before submitting the PR, please take the following into consideration

frank-zsy commented Aug 3, 2024

github-actions bot commented Aug 3, 2024

frank-zsy commented Aug 6, 2024

Neilblaze commented Aug 7, 2024

frank-zsy commented Aug 16, 2024

Neilblaze commented Aug 16, 2024 • edited Loading

frank-zsy commented Aug 16, 2024

Neilblaze commented Aug 16, 2024

frank-zsy commented Aug 16, 2024

frank-zsy commented Aug 28, 2024

frank-zsy commented Aug 28, 2024

github-actions bot commented Aug 28, 2024

Neilblaze commented Aug 29, 2024

Neilblaze commented Sep 11, 2024

github-actions bot commented Sep 11, 2024

Neilblaze commented Sep 11, 2024

Peng99999 commented Sep 12, 2024

Neilblaze commented Sep 12, 2024 • edited Loading

frank-zsy commented Sep 12, 2024

frank-zsy commented Sep 13, 2024

Neilblaze commented Sep 14, 2024

github-actions bot commented Sep 14, 2024

frank-zsy commented Sep 16, 2024

Neilblaze commented Sep 16, 2024

frank-zsy commented Sep 17, 2024

Neilblaze commented Sep 17, 2024

frank-zsy commented Sep 20, 2024

github-actions bot commented Sep 20, 2024

frank-zsy commented Sep 20, 2024

github-actions bot commented Sep 20, 2024

frank-zsy commented Sep 20, 2024

github-actions bot commented Sep 20, 2024

frank-zsy commented Sep 20, 2024

github-actions bot commented Sep 20, 2024

frank-zsy commented Sep 20, 2024

Neilblaze commented Sep 20, 2024 • edited Loading

frank-zsy commented Sep 20, 2024

Neilblaze commented Sep 20, 2024

frank-zsy commented Sep 21, 2024

Neilblaze commented Sep 22, 2024

Neilblaze commented Aug 1, 2024 •

edited

Loading

Neilblaze commented Aug 16, 2024 •

edited

Loading

Neilblaze commented Sep 12, 2024 •

edited

Loading

Neilblaze commented Sep 20, 2024 •

edited

Loading