Clarify GitHub All Contributors badge (#7690)

* Clarify GitHub All Contributors badge * Add documentation text
badges · Mar 6, 2022 · 2cf3591 · 2cf3591
1 parent 98c98ef
commit 2cf3591
Showing 1 changed file with 12 additions and 2 deletions.
diff --git a/services/github/github-all-contributors.service.js b/services/github/github-all-contributors.service.js
@@ -2,7 +2,17 @@ import Joi from 'joi'
 import { renderContributorBadge } from '../contributor-count.js'
 import { ConditionalGithubAuthV3Service } from './github-auth-service.js'
 import { fetchJsonFromRepo } from './github-common-fetch.js'
-import { documentation } from './github-helpers.js'
+import { documentation as commonDocumentation } from './github-helpers.js'
+
+const documentation = `
+<p>
+  The All Contributors service allows you to recognize all your project
+  contributors, including those that don't push code. See
+  <a href="https://allcontributors.org">https://allcontributors.org</a>
+  for more information.
+</p>
+${commonDocumentation}
+`
 
 const schema = Joi.object({
   contributors: Joi.array().required(),
@@ -17,7 +27,7 @@ export default class GithubAllContributorsService extends ConditionalGithubAuthV
 
   static examples = [
     {
-      title: 'Github All Contributors',
+      title: 'GitHub contributors (via allcontributors.org)',
       namedParams: {
         repo: 'all-contributors',
         user: 'all-contributors',