Skip to content

Commit

Permalink
docs: add how to use metrics doc and update base URL (#48)
Browse files Browse the repository at this point in the history
Signed-off-by: frank-zsy <[email protected]>
  • Loading branch information
frank-zsy authored Sep 28, 2024
1 parent 53aa5fe commit f74de63
Show file tree
Hide file tree
Showing 51 changed files with 1,005 additions and 200 deletions.
84 changes: 35 additions & 49 deletions docs/user_docs/intro.md

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/user_docs/metrics/activity.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@
## 数据

- **链接(基础):** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/activity.json`
- **链接(基础):** `https://oss.open-digger.cn/{platform}/{owner}/{repo}/activity.json`

- **链接(详情):** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/activity_details.json`
- **链接(详情):** `https://oss.open-digger.cn/{platform}/{owner}/{repo}/activity_details.json`

要获取特定仓库的数据,请将 `{platform}``{owner}``{repo}` 替换为实际名称。这里有一个[活跃度示例](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/activity.json)以及[活跃度详情示例](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/activity_details.json)
要获取特定仓库的数据,请将 `{platform}``{owner}``{repo}` 替换为实际名称。这里有一个[活跃度示例](https://oss.open-digger.cn/github/X-lab2017/open-digger/activity.json)以及[活跃度详情示例](https://oss.open-digger.cn/github/X-lab2017/open-digger/activity_details.json)

其中活跃度数据包含该仓库历史的活跃度统计情况,而活跃度详情数据则包含该仓库活跃度的组成情况,即每个开发者在仓库中的活跃度细节。

Expand Down
4 changes: 2 additions & 2 deletions docs/user_docs/metrics/activity_dates_and_times.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@
## 数据

**链接:** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/active_dates_and_times.json`
**链接:** `https://oss.open-digger.cn/{platform}/{owner}/{repo}/active_dates_and_times.json`

要获取特定存储库的数据,请将 `{platform}``{owner}``{repo}` 替换为实际名称。这里有一个[示例](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/active_dates_and_times.json)
要获取特定存储库的数据,请将 `{platform}``{owner}``{repo}` 替换为实际名称。这里有一个[示例](https://oss.open-digger.cn/github/X-lab2017/open-digger/active_dates_and_times.json)

## 代码

Expand Down
4 changes: 2 additions & 2 deletions docs/user_docs/metrics/change_request_reviews.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@
## 数据

**链接:** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/change_requests_reviews.json`
**链接:** `https://oss.open-digger.cn/{platform}/{owner}/{repo}/change_requests_reviews.json`

要获取特定存储库的数据,请将 `{platform}``{owner}``{repo}` 替换为实际名称。这里有一个 [示例](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/change_requests_reviews.json)
要获取特定存储库的数据,请将 `{platform}``{owner}``{repo}` 替换为实际名称。这里有一个 [示例](https://oss.open-digger.cn/github/X-lab2017/open-digger/change_requests_reviews.json)

## 代码

Expand Down
4 changes: 2 additions & 2 deletions docs/user_docs/metrics/change_requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@
## 数据

**链接:** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/change_requests.json`
**链接:** `https://oss.open-digger.cn/{platform}/{owner}/{repo}/change_requests.json`

要获取特定存储库的数据,请将 `{platform}``{owner}``{repo}` 替换为实际名称。这里有一个 [示例](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/change_requests.json)
要获取特定存储库的数据,请将 `{platform}``{owner}``{repo}` 替换为实际名称。这里有一个 [示例](https://oss.open-digger.cn/github/X-lab2017/open-digger/change_requests.json)

## 代码

Expand Down
4 changes: 2 additions & 2 deletions docs/user_docs/metrics/change_requests_accepted.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@
## 数据

**链接:** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/change_requests_accepted.json`
**链接:** `https://oss.open-digger.cn/{platform}/{owner}/{repo}/change_requests_accepted.json`

要获取特定存储库的数据,请将 `{platform}``{owner}``{repo}` 替换为实际名称。这里有一个 [示例](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/change_requests_accepted.json)
要获取特定存储库的数据,请将 `{platform}``{owner}``{repo}` 替换为实际名称。这里有一个 [示例](https://oss.open-digger.cn/github/X-lab2017/open-digger/change_requests_accepted.json)

## 代码

Expand Down
4 changes: 2 additions & 2 deletions docs/user_docs/metrics/change_requests_age.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@
## 数据

**链接:** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/change_request_age.json`
**链接:** `https://oss.open-digger.cn/{platform}/{owner}/{repo}/change_request_age.json`

要获取特定存储库的数据,请将 `{platform}``{owner}``{repo}` 替换为实际名称。这里有一个 [示例](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/change_request_age.json)
要获取特定存储库的数据,请将 `{platform}``{owner}``{repo}` 替换为实际名称。这里有一个 [示例](https://oss.open-digger.cn/github/X-lab2017/open-digger/change_request_age.json)

## 代码

Expand Down
4 changes: 2 additions & 2 deletions docs/user_docs/metrics/change_requests_resolution_duration.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@
## 数据

**链接:** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/change_request_resolution_duration.json`
**链接:** `https://oss.open-digger.cn/{platform}/{owner}/{repo}/change_request_resolution_duration.json`

要获取特定存储库的数据,请将 `{platform}``{owner}``{repo}` 替换为实际名称。这里有一个 [示例](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/change_request_resolution_duration.json)
要获取特定存储库的数据,请将 `{platform}``{owner}``{repo}` 替换为实际名称。这里有一个 [示例](https://oss.open-digger.cn/github/X-lab2017/open-digger/change_request_resolution_duration.json)

## 代码

Expand Down
4 changes: 2 additions & 2 deletions docs/user_docs/metrics/change_requests_response_time.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@
## 数据

**链接:** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/change_request_response_time.json`
**链接:** `https://oss.open-digger.cn/{platform}/{owner}/{repo}/change_request_response_time.json`

要获取特定存储库的数据,请将 `{platform}``{owner}``{repo}` 替换为实际名称。这里有一个 [示例](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/change_request_response_time.json)
要获取特定存储库的数据,请将 `{platform}``{owner}``{repo}` 替换为实际名称。这里有一个 [示例](https://oss.open-digger.cn/github/X-lab2017/open-digger/change_request_response_time.json)

## 代码

Expand Down
8 changes: 4 additions & 4 deletions docs/user_docs/metrics/code_changes_lines.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@
## 数据

- **链接 (添加):** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/code_change_lines_add.json`
- **链接 (删除):** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/code_change_lines_remove.json`
- **链接 (总和):** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/code_change_lines_sum.json`
- **链接 (添加):** `https://oss.open-digger.cn/{platform}/{owner}/{repo}/code_change_lines_add.json`
- **链接 (删除):** `https://oss.open-digger.cn/{platform}/{owner}/{repo}/code_change_lines_remove.json`
- **链接 (总和):** `https://oss.open-digger.cn/{platform}/{owner}/{repo}/code_change_lines_sum.json`

要获取某个仓库的数据,请将 `{platform}``{owner}``{repo}` 替换为实际名称。对于`代码添加`,请参考此 [示例](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/code_change_lines_add.json)。类似地,对于`代码删除`,请参考此 [示例](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/code_change_lines_remove.json),对于`代码变更总和`,请参考此 [示例](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/code_change_lines_sum.json)
要获取某个仓库的数据,请将 `{platform}``{owner}``{repo}` 替换为实际名称。对于`代码添加`,请参考此 [示例](https://oss.open-digger.cn/github/X-lab2017/open-digger/code_change_lines_add.json)。类似地,对于`代码删除`,请参考此 [示例](https://oss.open-digger.cn/github/X-lab2017/open-digger/code_change_lines_remove.json),对于`代码变更总和`,请参考此 [示例](https://oss.open-digger.cn/github/X-lab2017/open-digger/code_change_lines_sum.json)

## 代码

Expand Down
6 changes: 3 additions & 3 deletions docs/user_docs/metrics/contributor_absence_factor.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@
## 数据

**链接(基础):** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/bus_factor.json`
**链接(基础):** `https://oss.open-digger.cn/{platform}/{owner}/{repo}/bus_factor.json`

**链接(详细):** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/bus_factor_detail.json`
**链接(详细):** `https://oss.open-digger.cn/{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)
要获取特定仓库的数据,请将`{platform}``{owner}``{repo}` 替换为实际名称。这里有一个[示例](https://oss.open-digger.cn/github/X-lab2017/open-digger/bus_factor.json)

## 代码

Expand Down
6 changes: 3 additions & 3 deletions docs/user_docs/metrics/contributors.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@
## 数据

- **链接 (基础):** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/contributors.json`
- **链接 (详情):** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/contributors_detail.json`
- **链接 (基础):** `https://oss.open-digger.cn/{platform}/{owner}/{repo}/contributors.json`
- **链接 (详情):** `https://oss.open-digger.cn/{platform}/{owner}/{repo}/contributors_detail.json`

要获取某个仓库的数据,请将 `{platform}``{owner}``{repo}` 替换为实际名称。对于基础变体,请参考此 [示例](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/contributors.json),对于详情数据,请参考此 [示例](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/contributors_detail.json)
要获取某个仓库的数据,请将 `{platform}``{owner}``{repo}` 替换为实际名称。对于基础变体,请参考此 [示例](https://oss.open-digger.cn/github/X-lab2017/open-digger/contributors.json),对于详情数据,请参考此 [示例](https://oss.open-digger.cn/github/X-lab2017/open-digger/contributors_detail.json)

## 代码

Expand Down
2 changes: 0 additions & 2 deletions docs/user_docs/metrics/how_to_use.md

This file was deleted.

4 changes: 2 additions & 2 deletions docs/user_docs/metrics/inactive_contributors.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@
## 数据

**链接:** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/inactive_contributors.json`
**链接:** `https://oss.open-digger.cn/{platform}/{owner}/{repo}/inactive_contributors.json`

要获取特定存储库的数据,请将 `{platform}``{owner}``{repo}` 替换为实际名称。这里有一个[示例](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/inactive_contributors.json)
要获取特定存储库的数据,请将 `{platform}``{owner}``{repo}` 替换为实际名称。这里有一个[示例](https://oss.open-digger.cn/github/X-lab2017/open-digger/inactive_contributors.json)

## 代码

Expand Down
4 changes: 2 additions & 2 deletions docs/user_docs/metrics/issue_age.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@
## 数据

**链接:** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/issue_age.json`
**链接:** `https://oss.open-digger.cn/{platform}/{owner}/{repo}/issue_age.json`

要获取某个仓库的数据,请将 `{platform}``{owner}``{repo}` 替换为实际名称。更多信息请参考此 [示例](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/issue_age.json)
要获取某个仓库的数据,请将 `{platform}``{owner}``{repo}` 替换为实际名称。更多信息请参考此 [示例](https://oss.open-digger.cn/github/X-lab2017/open-digger/issue_age.json)

## 代码

Expand Down
4 changes: 2 additions & 2 deletions docs/user_docs/metrics/issue_closed.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@
## 数据

**链接:** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/issues_closed.json`
**链接:** `https://oss.open-digger.cn/{platform}/{owner}/{repo}/issues_closed.json`

要获取某个仓库的数据,请将 `{platform}``{owner}``{repo}` 替换为实际名称。更多信息请参考此 [示例](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/issues_closed.json)
要获取某个仓库的数据,请将 `{platform}``{owner}``{repo}` 替换为实际名称。更多信息请参考此 [示例](https://oss.open-digger.cn/github/X-lab2017/open-digger/issues_closed.json)

## 代码

Expand Down
4 changes: 2 additions & 2 deletions docs/user_docs/metrics/issue_new.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@
## 数据

**链接:** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/issues_new.json`
**链接:** `https://oss.open-digger.cn/{platform}/{owner}/{repo}/issues_new.json`

要获取某个仓库的数据,请将 `{platform}``{owner}``{repo}` 替换为实际名称。更多信息请参考此 [示例](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/issues_new.json)
要获取某个仓库的数据,请将 `{platform}``{owner}``{repo}` 替换为实际名称。更多信息请参考此 [示例](https://oss.open-digger.cn/github/X-lab2017/open-digger/issues_new.json)

## 代码

Expand Down
4 changes: 2 additions & 2 deletions docs/user_docs/metrics/issue_resolution_duration.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@
## 数据

**链接:** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/issue_resolution_duration.json`
**链接:** `https://oss.open-digger.cn/{platform}/{owner}/{repo}/issue_resolution_duration.json`

要获取特定存储库的数据,请将 `{platform}``{owner}``{repo}` 替换为实际名称。这里有一个[示例](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/issue_resolution_duration.json)
要获取特定存储库的数据,请将 `{platform}``{owner}``{repo}` 替换为实际名称。这里有一个[示例](https://oss.open-digger.cn/github/X-lab2017/open-digger/issue_resolution_duration.json)

## 代码

Expand Down
4 changes: 2 additions & 2 deletions docs/user_docs/metrics/issue_response_time.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@
## 数据

**链接:** `https://oss.x-lab.info/open_digger/{platform}/{owner}/{repo}/issue_response_time.json`
**链接:** `https://oss.open-digger.cn/{platform}/{owner}/{repo}/issue_response_time.json`

要获取特定存储库的数据,请将 `{platform}``{owner}``{repo}` 替换为实际名称。这里有一个[示例](https://oss.x-lab.info/open_digger/github/X-lab2017/open-digger/issue_response_time.json)
要获取特定存储库的数据,请将 `{platform}``{owner}``{repo}` 替换为实际名称。这里有一个[示例](https://oss.open-digger.cn/github/X-lab2017/open-digger/issue_response_time.json)

## 代码

Expand Down
Loading

0 comments on commit f74de63

Please sign in to comment.