docs: added content for bus-factor + technical fork (EN + ZH) (#25)

* docs: content for bus-factor Signed-off-by: neilblaze <[email protected]> * docs: modified bus-factor (ZH) & added Technical Fork (ZH) Signed-off-by: neilblaze <[email protected]> * doc: update chinese part Signed-off-by: frank-zsy <[email protected]> --------- Signed-off-by: neilblaze <[email protected]> Signed-off-by: frank-zsy <[email protected]> Co-authored-by: frank-zsy <[email protected]>
X-lab2017 · Jul 9, 2024 · 1751e2c · 1751e2c
1 parent c2ecbc7
commit 1751e2c
Show file tree

Hide file tree

Showing 5 changed files with 79 additions and 18 deletions.
diff --git a/docs/user_docs/metrics/bus_factor.md b/docs/user_docs/metrics/bus_factor.md
@@ -0,0 +1,30 @@
+# 巴士系数(Bus Factor)
+
+![From](https://img.shields.io/badge/来自-CHAOSS-blue) ![For](https://img.shields.io/badge/用于-仓库-blue)
+
+## 定义
+
+巴士系数，或称为 Contributor Absence Factor，是由 [CHAOSS 社区](https://chaoss.community) 定义的一个指标。有关该指标的详细定义，请参阅 [CHAOSS Metrics - Bus Factor](https://chaoss.community/metric-bus-factor/)。
+
+巴士系数是一个引人注目的指标，因为它形象的表达了一个问题，即：“在项目停滞之前，我们可以失去多少贡献者？”。巴士系数的计算是项目贡献量 50% 的最少人数，并表明了项目失去关键贡献者（包括维护者）后的韧性程度。
+
+> 它有助于识别项目中的工作如何分布在贡献者之间，以及项目中做了大部分工作的关键人物。
+
+## 数据
+
+- **链接（基础）：** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/bus_factor.json`
+- **链接（详细）：** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/bus_factor_detail.json`
+
+要获取特定仓库的数据，请将`{platform}`、`{owner}`和`{repo}`替换为实际名称。这里有一个[示例](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/bus_factor.json)。
+
+## 代码
+
+这里是[**实现代码**](https://github.com/X-lab2017/open-digger/blob/54478a97911a24a33e69147a985115b084c24f3f/src/metrics/chaoss.ts#L672)。
+
+## CodePen 演示
+
+<iframe height="600" scrolling="no" title="OpenDigger — [X-lab] OpenRank/Activity/Bus Factor" src="https://codepen.io/frank-zsy/embed/bGjyqQj?type=bus_factor&default-tab=js%2Cresult&editable=true" frameborder="no" loading="lazy" allowtransparency="true" allowfullscreen="true">
+  See the Pen <a href="https://codepen.io/frank-zsy/pen/bGjyqQj">
+  OpenDigger - [X-lab] OpenRank/Activity/Bus Factor</a> by Frank Zhao (<a href="https://codepen.io/frank-zsy">@frank-zsy</a>)
+  on <a href="https://codepen.io">CodePen</a>.
+</iframe>
diff --git a/docs/user_docs/metrics/technical_fork.md b/docs/user_docs/metrics/technical_fork.md
@@ -1,29 +1,26 @@
-# Technical Fork (To be Translated)
+# 技术分叉(Technical Fork)
 
-![Type](https://img.shields.io/badge/Type-Metric-blue) ![From](https://img.shields.io/badge/From-CHAOSS-blue) ![For](https://img.shields.io/badge/For-Repo-blue)
+![From](https://img.shields.io/badge/来自-CHAOSS-blue) ![For](https://img.shields.io/badge/用于-仓库-blue)
 
-## Definition
+## 定义
 
-Technical Fork is a metric defined by [CHAOSS](https://chaoss.community), see [CHAOSS Metrics - Technical Fork](https://chaoss.community/kb/metric-technical-fork/) for the detailed definition of this metric.
+技术分叉是由 [CHAOSS 社区](https://chaoss.community)定义的一个指标，有关该指标的详细定义，请参阅 [CHAOSS Metrics - Technical Fork](https://chaoss.community/kb/metric-technical-fork/)。
 
-A technical fork is a distributed version control copy of a project. The number of technical forks indicates the number of copies of a project on the same code development platform.
+技术分叉是仓库的分布式版本控制的副本。技术分叉的数量表示同一代码开发平台上仓库的副本数量。
 
-> Fork from the same developer will be double counted. For example, if a developer has deleted the forked repository and then fork again, the latter fork will also be counted in the total.
+> 来自同一开发人员的分叉将被重复计算。例如，如果开发人员已经删除了分叉的仓库，然后再次分叉，则后者也将计入总数。
 
+## 数据
 
-## Data
+**链接：** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/technical_fork.json`
 
-**Link:** `https://oss.x-lab.info/open_digger/github/{owner}/{repo}/technical_fork.json`
+要获取特定存储库的数据，请将`{platform}`、`{owner}`和`{repo}`替换为实际名称。这里有一个[示例](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/technical_fork.json)。
 
-To get the data for a certain repository, replace `{owner}` and `{repo}` with the actual name. Here is an [example](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/technical_fork.json).
+## 代码
 
-## Code
+这里是[**实现代码**](https://github.com/X-lab2017/open-digger/blob/465d2e3ddb57c0da7fab18435f711d4fa0a63f22/src/metrics/chaoss.ts#L12)。
 
-Here's the [**implementation code**](https://github.com/X-lab2017/open-digger/blob/465d2e3ddb57c0da7fab18435f711d4fa0a63f22/src/metrics/chaoss.ts#L12).
-
-
-
-## CodePen Demo
+## CodePen 演示
 
 <iframe height="600" scrolling="no" title="OpenDigger - [X-lab] Attention/Stars/Technical Fork/Bus Factor" src="https://codepen.io/frank-zsy/embed/MWBdpNg?type=technical_fork&default-tab=js%2Cresult&editable=true" frameborder="no" loading="lazy" allowtransparency="true" allowfullscreen="true">
   See the Pen <a href="https://codepen.io/frank-zsy/pen/MWBdpNg?type=technical_fork">

diff --git a/i18n/en/docusaurus-plugin-content-docs/current/user_docs/metrics/bus_factor.md b/i18n/en/docusaurus-plugin-content-docs/current/user_docs/metrics/bus_factor.md
@@ -0,0 +1,33 @@
+# Bus Factor
+
+![From](https://img.shields.io/badge/From-CHAOSS-blue) ![For](https://img.shields.io/badge/For-Repo-blue)
+
+## Definition
+
+Bus Factor, or modernly Contributor Absence Factor is a metric defined by [CHAOSS](https://chaoss.community), see [CHAOSS Metrics - Bus Factor](https://chaoss.community/metric-bus-factor/) for a detailed definition of this metric.
+
+The Bus Factor is a compelling metric because it visualizes the question "How many contributors can we lose before a project stalls?". It is the smallest number of people that make 50% of contributions to the project & indicates a measure of the project's resilience to losing key contributors (including maintainers).
+
+> It helps identify how widely the work in a project is distributed across contributors as well as the key people in a project that are doing the majority of the work.
+
+
+## Data
+
+- **Link (base):** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/bus_factor.json`
+- **Link (detail):** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/bus_factor_detail.json`
+
+
+To get the data for a certain repository, replace `{platform}`, `{owner}` and `{repo}` with the actual name. Here is an [example](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/bus_factor.json).
+
+## Code
+
+Here's the [**implementation code**](hhttps://github.com/X-lab2017/open-digger/blob/54478a97911a24a33e69147a985115b084c24f3f/src/metrics/chaoss.ts#L672).
+
+
+## CodePen Demo
+
+<iframe height="600" scrolling="no" title="OpenDigger — [X-lab] OpenRank/Activity/Bus Factor" src="https://codepen.io/frank-zsy/embed/bGjyqQj?type=bus_factor&default-tab=js%2Cresult&editable=true" frameborder="no" loading="lazy" allowtransparency="true" allowfullscreen="true">
+  See the Pen <a href="https://codepen.io/frank-zsy/pen/bGjyqQj">
+  OpenDigger - [X-lab] OpenRank/Activity/Bus Factor</a> by Frank Zhao (<a href="https://codepen.io/frank-zsy">@frank-zsy</a>)
+  on <a href="https://codepen.io">CodePen</a>.
+</iframe>
diff --git a/i18n/en/docusaurus-plugin-content-docs/current/user_docs/metrics/technical_fork.md b/i18n/en/docusaurus-plugin-content-docs/current/user_docs/metrics/technical_fork.md
@@ -1,6 +1,6 @@
 # Technical Fork
 
-![Type](https://img.shields.io/badge/Type-Metric-blue) ![From](https://img.shields.io/badge/From-CHAOSS-blue) ![For](https://img.shields.io/badge/For-Repo-blue)
+![From](https://img.shields.io/badge/From-CHAOSS-blue) ![For](https://img.shields.io/badge/For-Repo-blue)
 
 ## Definition
 
@@ -13,9 +13,9 @@ A technical fork is a distributed version control copy of a project. The number
 
 ## Data
 
-**Link:** `https://oss.x-lab.info/open_digger/github/{owner}/{repo}/technical_fork.json`
+**Link:** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/technical_fork.json`
 
-To get the data for a certain repository, replace `{owner}` and `{repo}` with the actual name. Here is an [example](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/technical_fork.json).
+To get the data for a certain repository, replace `{platform}`, `{owner}` and `{repo}` with the actual name. Here is an [example](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/technical_fork.json).
 
 ## Code
 

diff --git a/sidebars.js b/sidebars.js
@@ -42,6 +42,7 @@ const sidebars = {
           ],
         },
         'user_docs/metrics/technical_fork',
+        'user_docs/metrics/bus_factor',
       ],
     },
     'user_docs/FAQ'
-Original file line number
+Diff line change
@@ Expand Up / @@ -42,6 +42,7 @@ const sidebars = { @@
               ],
             },
             'user_docs/metrics/technical_fork',
+            'user_docs/metrics/bus_factor',
           ],
         },
         'user_docs/FAQ'
@@ Expand Down @@