[Docs] Add more docs about metrics description

[frank-zsy]

Right now the website only contains the Chinese documentation of OpenDigger metric.

We should add docs for all the metrics listed in the introduction https://open-digger.cn/en/docs/user_docs/intro

The original issue could be found in https://github.com/X-lab2017/open-digger/issues?q=is%3Aissue+Metrics+in%3Atitle

And there is an example in our old website: https://x-lab2017.github.io/open-digger/#/metrics/technical_fork

The metrics description should be placed under https://open-digger.cn/en/docs/user_docs/metrics/how_to_use

We can add both English and Chinese version with English content in the first place and translate the docs later

[Neilblaze]

@frank-zsy Linking to #7, before moving forward, I'm curious to know where I can get access to "all the metrics" (since you mentioned), where all I can see is "Indicator usage guide"

I'd love to have a chat with you to get things on the same plate asap.

[frank-zsy]

Yes, the docs are not complete right now and that's why we have an OSPP task for this.

First, you should understand what does OpenDigger do as an open source project and how does it provide open source metrics to developers.

The introduction of the usage of all metrics and the metrics list can be found in current user doc introduction and the details of each metric can be found in the corresponding issue, like new issues.

Most metrics are from CHAOSS community and we add the links into the issues too.

So the docs task should be adding docs for each metric that OpenDigger provides and corresponding resources, like CHAOSS definition, data examples or even usage example like CodePen demos or even some ECharts components implemented in this website.

[Neilblaze]

Oh, I get it now. Also, I'm curious to know, do we have a list of codepen (example) links that I can use to tap into (as of now) ?

[frank-zsy]

Yes, in the introduction documentation, you can find CodePen demo URL in each row of the metrics.

[Neilblaze]

Thanks, I'll take a look!

[Neilblaze]

Just confirming, #11 is linked with #1183, correct?

[frank-zsy]

Yes, actually it is for the old version website, but still valid for this repo.