This is an automated email from the ASF dual-hosted git repository. zky pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
commit a63c50ad1feab4484c105582826a9c3b2902029e Author: linyh <[email protected]> AuthorDate: Thu Jul 28 21:23:39 2022 +0800 fix: fix for review --- docs/DeveloperManuals/PluginImplementation.md | 7 +++++-- .../current/DeveloperManuals/PluginImplementation.md | 7 ++++++- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/DeveloperManuals/PluginImplementation.md b/docs/DeveloperManuals/PluginImplementation.md index 999a43d9..a27609bf 100644 --- a/docs/DeveloperManuals/PluginImplementation.md +++ b/docs/DeveloperManuals/PluginImplementation.md @@ -69,9 +69,12 @@ There's a lot of information in the diagram but we don't expect you to digest it ## A step-by-step guide towards your first plugin -In this guide, we'll walk through how to create a data source plugin from scratch. +In this section, we will describe how to create a data collection plugin from scratch. The data to be collected is the information about all Committers and Contributors of the Apache project, in order to check whether they have signed the CLA. We are going to -Apache requires the project to confirm whether the Contributors and Committers of the project have signed the CLA. So we need to check whether committers have signed the CLA by requesting Apache API and whether contributors have signed by requesting the mailing list. Here we will explain how to request and cache committer information from the Apache API and extract the structured data. There is just an introduction for contributors' at the end of this article. +* request `https://people.apache.org/public/icla-info.json` to get the Committers' information +* request the `mailing list` to get the Contributors' information + +We will focus on demonstrating how to request and cache information about all Committers through the Apache API and extract structured data from it. The collection of Contributors will only be briefly described. ### Step 1: Bootstrap the new plugin diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/DeveloperManuals/PluginImplementation.md b/i18n/zh/docusaurus-plugin-content-docs/current/DeveloperManuals/PluginImplementation.md index 5be001f2..fffcb020 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/DeveloperManuals/PluginImplementation.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/DeveloperManuals/PluginImplementation.md @@ -70,7 +70,12 @@ flowchart TD ## 一起来实现一个最简单的插件 -在本节中，将介绍如何从头创建一个数据收集插件。要收集的数据是 Apache 项目的所有 Committer 和 Contributor，Apache 要求项目确认项目的 Contributor 和 Committer 是否签署了CLA，我们需要通过请求`https://people.apache.org/public/icla-info.json`来检查 Committer、通过请求邮件列表检查 Contributor 是否签署了CLA。这里我们将演示如何从Apache API中请求并缓存所有Committer的信息，并提取出结构化的数据，Contributor 的检查仅做一些思路的介绍。 +在本节中，我们将介绍如何从头创建一个数据收集插件。要收集的数据是 Apache 项目的所有 Committers 和 Contributors 信息，目的是检查其是否签署了 CLA。我们将通过: + +* 请求 `https://people.apache.org/public/icla-info.json` 获取 Committers 信息 +* 请求`邮件列表` 获取 Contributors 信息 + 我们将演示如何通过 Apache API 请求并缓存所有 Committers 的信息，并提取出结构化的数据。Contributors 的收集仅做一些思路的介绍。 + ### 一、 创建新的插件
