[GitHub] [incubator-devlake-website] Startrekzky commented on a diff in pull request #345: docs: the github plugin docs in v0.15

[GitBox <gi...@apache.org>]

Startrekzky commented on code in PR #345:
URL: https://github.com/apache/incubator-devlake-website/pull/345#discussion_r1046887305


##########
docs/Plugins/github.md:
##########
@@ -14,23 +12,29 @@ This plugin gathers data from `GitHub` to display information to the user in `Gr
 - How fast do we respond to customer requirements?
 - Was our quality improved or not?
 
-## Metrics
-
-Here are some examples metrics using `GitHub` data:
-- Avg Requirement Lead Time By Assignee
-- Bug Count per 1k Lines of Code
-- Commit Count over Time
+## Entities
 
-## Screenshot
+- [entities](https://devlake.apache.org/docs/next/Overview/SupportedDataSources)
 
-![image](/img/Plugins/github-demo.png)
+## Metrics
 
+- [Requirement Count](https://devlake.apache.org/docs/next/Metrics/RequirementCount)

Review Comment:
   Use the relative path, not an absolute path of the next version of docs.



##########
docs/Plugins/github.md:
##########
@@ -14,23 +12,29 @@ This plugin gathers data from `GitHub` to display information to the user in `Gr
 - How fast do we respond to customer requirements?
 - Was our quality improved or not?
 
-## Metrics
-
-Here are some examples metrics using `GitHub` data:
-- Avg Requirement Lead Time By Assignee
-- Bug Count per 1k Lines of Code
-- Commit Count over Time
+## Entities
 
-## Screenshot
+- [entities](https://devlake.apache.org/docs/next/Overview/SupportedDataSources)

Review Comment:
   1. Add some texts here, "Look at the [entities](URL) collected by this plugin."
   2. It's better to use the relative path, not an absolute path of the `next` version of docs.
   3. you should add the anchor '#data-collection-scope-by-each-plugin' at the end of this page to jump to the right section of the supported data source page.



##########
docs/Plugins/github.md:
##########
@@ -39,29 +43,26 @@ To collect data, select `Advanced Mode` on the `Create Pipeline Run` page and pa
       "plugin": "github",
       "options": {
         "connectionId": 1,
-        "repo": "lake",
-        "owner": "merico-dev"
+        "owner": "apache",
+        "repo": "incubator-devlake",
+        "transformationRules": {
+          "deploymentPattern": "",
+          "issueComponent": "",
+          "issuePriority": "(high|medium|low)$",
+          "issueSeverity": "",
+          "issueTypeBug": "(bug)$",
+          "issueTypeIncident": "",
+          "issueTypeRequirement": "(feature|feature-request)$",
+          "prBodyClosePattern": "",
+          "prComponent": "",
+          "prType": "(?i)push"
+        }
       }
     }
   ]
 ]
 ```
 
-You can also trigger data collection by making a POST request to `/pipelines`.
-```
-curl 'http://localhost:8080/pipelines' \
---header 'Content-Type: application/json' \
---data-raw '
-{
-    "name": "github 20211126",
-    "tasks": [[{
-        "plugin": "github",
-        "options": {
-            "connectionId": 1,
-            "repo": "lake",
-            "owner": "merico-dev"
-        }
-    }]]
-}
-'
-```
+## References
+
+- [references](https://devlake.apache.org/docs/next/DeveloperManuals)

Review Comment:
   Use relative path



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@devlake.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org