You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by GitBox <gi...@apache.org> on 2022/11/14 08:08:33 UTC

[GitHub] [incubator-devlake-website] likyh opened a new pull request, #323: docs: explain how to use graphql in github

likyh opened a new pull request, #323:
URL: https://github.com/apache/incubator-devlake-website/pull/323

   # Summary
   
   <!--
   Thanks for submitting a PR! We appreciate you spending the time to work on these changes. Please fill out as many sections below as possible.
   -->
   
   1. update pic for "add connection in github"
   2. explain how to use graphql in github
   


-- 
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


[GitHub] [incubator-devlake-website] Startrekzky commented on a diff in pull request #323: docs: explain how to use graphql in github

Posted by GitBox <gi...@apache.org>.
Startrekzky commented on code in PR #323:
URL: https://github.com/apache/incubator-devlake-website/pull/323#discussion_r1021443893


##########
docs/UserManuals/ConfigUI/GitHub.md:
##########
@@ -23,6 +23,13 @@ GitHub personal access tokens are required to add a connection.
   - `read:org`
 - The data collection speed is relatively slow for GitHub since they have a **rate limit of [5,000 requests](https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting) per hour** (15,000 requests/hour if you pay for GitHub enterprise). You can accelerate the process by configuring _multiple_ personal access tokens. Please note that multiple tokens should be created by different GitHub accounts. Tokens belonging to the same GitHub account share the rate limit.
 
+#### Use Graphql APIs
+
+If you use `github.com` or your private GitHub Service supported, you could open this switcher to collect data more swiftly.

Review Comment:
   1. Text change: 
   "If you are using 'github.com' or your on-premise GitHub version supports GraphQL APIs, toggle on this setting to collect data quicker."
   2. Add a screenshot of this setting.



##########
docs/UserManuals/ConfigUI/GitHub.md:
##########
@@ -23,6 +23,13 @@ GitHub personal access tokens are required to add a connection.
   - `read:org`
 - The data collection speed is relatively slow for GitHub since they have a **rate limit of [5,000 requests](https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting) per hour** (15,000 requests/hour if you pay for GitHub enterprise). You can accelerate the process by configuring _multiple_ personal access tokens. Please note that multiple tokens should be created by different GitHub accounts. Tokens belonging to the same GitHub account share the rate limit.
 
+#### Use Graphql APIs
+
+If you use `github.com` or your private GitHub Service supported, you could open this switcher to collect data more swiftly.
+
+- GraphQL APIs are 10+ times faster than REST APIs, but it may not be supported in GitHub on-premise versions. 

Review Comment:
   Text change:
   "GraphQL APIs are 10+ times faster than REST APIs, but they may not be supported in GitHub on-premise versions."



##########
docs/UserManuals/ConfigUI/GitHub.md:
##########
@@ -23,6 +23,13 @@ GitHub personal access tokens are required to add a connection.
   - `read:org`
 - The data collection speed is relatively slow for GitHub since they have a **rate limit of [5,000 requests](https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting) per hour** (15,000 requests/hour if you pay for GitHub enterprise). You can accelerate the process by configuring _multiple_ personal access tokens. Please note that multiple tokens should be created by different GitHub accounts. Tokens belonging to the same GitHub account share the rate limit.
 
+#### Use Graphql APIs
+
+If you use `github.com` or your private GitHub Service supported, you could open this switcher to collect data more swiftly.
+
+- GraphQL APIs are 10+ times faster than REST APIs, but it may not be supported in GitHub on-premise versions. 
+- GraphQL only uses 1 token to collect data because it's quick enough.

Review Comment:
   Text change:
   "Instead of using multiple tokens to collect data, you can use ONLY ONE token because GraphQL APIs are quick enough."



-- 
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


[GitHub] [incubator-devlake-website] Startrekzky merged pull request #323: docs: explain how to use graphql in github

Posted by GitBox <gi...@apache.org>.
Startrekzky merged PR #323:
URL: https://github.com/apache/incubator-devlake-website/pull/323


-- 
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


[GitHub] [incubator-devlake-website] likyh commented on a diff in pull request #323: docs: explain how to use graphql in github

Posted by GitBox <gi...@apache.org>.
likyh commented on code in PR #323:
URL: https://github.com/apache/incubator-devlake-website/pull/323#discussion_r1021479692


##########
docs/UserManuals/ConfigUI/GitHub.md:
##########
@@ -23,6 +23,13 @@ GitHub personal access tokens are required to add a connection.
   - `read:org`
 - The data collection speed is relatively slow for GitHub since they have a **rate limit of [5,000 requests](https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting) per hour** (15,000 requests/hour if you pay for GitHub enterprise). You can accelerate the process by configuring _multiple_ personal access tokens. Please note that multiple tokens should be created by different GitHub accounts. Tokens belonging to the same GitHub account share the rate limit.
 
+#### Use Graphql APIs
+
+If you use `github.com` or your private GitHub Service supported, you could open this switcher to collect data more swiftly.

Review Comment:
   The snapshot is in Line#9



-- 
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