X-lab2017 / open-digger-website

Official Website for OpenDigger Community
https://open-digger.cn
Apache License 2.0
6 stars 6 forks source link

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

Closed Neilblaze closed 1 month ago

Neilblaze commented 1 month ago

Description

Fixed typo in Bus Factor, updated dependencies to latest & added new metrics (both EN & ZH), for the following, mentioned below (includes updates from 20/04/2024) :

🦄 Tested on local, build running successfully!

Ref : Slack Discussion / cc: @Peng99999, @frank-zsy
â—‹ Partially resolves #24

Before submitting the PR, please take the following into consideration

frank-zsy commented 1 month ago

Thanks for the docs. I will update the Chinese version.

I think you should start with CHAOSS statistical metrics since they are quite easy and have CHAOSS documentations as reference.

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

frank-zsy commented 1 month ago

Actually time period related metrics like resolution duration and response time are also tricky. So these metrics will involve deep collaboration with me.

Neilblaze commented 1 month ago

Thanks for the docs. I will update the Chinese version.

Sounds good, thank you! 😄

I think you should start with CHAOSS statistical metrics since they are quite easy and have CHAOSS documentations as reference.

I see, thanks for the heads up! Alright, I'll prioritize CHAOSS metrics first, and once those are completed, I'll start digging into the X-lab metrics with your guidance.

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

Got it!

frank-zsy commented 1 month ago

/preview

github-actions[bot] commented 1 month ago

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

frank-zsy commented 1 month ago

@Neilblaze I add LaTeX support and modify the docs, could you modify the English version due to my modification? Especially activity metrics. And activity and activity details are both included in the activity part now.

And I think we can remove the English name of each metrics in the Chinese doc titles and we do not need to translate Issue and PR.

Neilblaze commented 1 month ago

Yessir, I'll do that :)

Neilblaze commented 1 month ago

/preview

github-actions[bot] commented 1 month ago

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

frank-zsy commented 1 month ago

/preview

github-actions[bot] commented 1 month ago

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

frank-zsy commented 1 month ago

This PR LGTM now. Thanks for the great work!

I will merge this PR now and further more:

Neilblaze commented 1 month ago

@frank-zsy Thanks for merging the PR! 😃

I think change request response time and resolution duration could be merged with issue corresponding metrics.

Sure thing! In the next PR, I'll make sure to do this. But I'm also a little curious, (assuming that I haven't misinterpreted what you mentioned) what I can see is that if we're aiming to keep a standalone section for issue corresponding metrics, there are six of them, that we'll have to handle:

image

Do you have any thoughts regarding this?


Pls feel free to raise PR and discuss on GitHub, since Slack is not quite stable in China, I can only receive the notification but can not retrieve the messages smoothly. Sorry for that.

Thanks for the heads up! I understand that Slack isn't that accessible in China, so I do recommend enabling GitHub Discussions in this repo, which will be very helpful for everyone.

Thanks :)

Neilblaze commented 1 month ago

@frank-zsy Also, for this:

image

Should I create separate metrics page (individual pages / each) for each OR create one separate metrics section and under that keep these nested, which will look something like this:

frank-zsy commented 1 month ago

Thanks for the heads up! I understand that Slack isn't that accessible in China, so I do recommend enabling GitHub Discussions in this repo, which will be very helpful for everyone.

Of course we can enable discussion for this repo, however I don't really fond of this function because discussion events can not be collected by GitHub events API, so OpenDigger can not analyze the data in discussion right now.

Should I create separate metrics page (individual pages / each) for each OR create one separate metrics section and under that keep these nested, which will look something like this:

I think group change request and issue metrics to a category is cool and helps to organize the catalog and make it much clearer.

Neilblaze commented 1 month ago

@frank-zsy UPDATE:

For this, I tried to keep the "Issues" section standalone and then keep two inter-sections "new" and "closed", but due to the overflow, I feel that is making the entire table ugly 😅

image

So, I'm keeping it as it is, plus I feel it makes things easier for people to perform individual search on different topics. Rest aside, if anyone wants something specific, they can use the search-bar. ^_^

Thoughts?

Neilblaze commented 1 month ago

So for now, I'll start shipping out PRs for the rest of the metrics, keeping the priority on CHAOSS first, then once those are done, I can move into x-lab ones, where I'll hopefully require some help :)

frank-zsy commented 1 month ago

Sure, you can ship your PR first as your understanding and we can collaborate on the PR directly. And Discussion is ready now for any further questions.