From b13116870fd910dfeab259d54ed82616119a684d Mon Sep 17 00:00:00 2001 From: Caleb Cartwright Date: Mon, 2 Mar 2020 11:27:18 -0600 Subject: [PATCH] docs: add inline wercker ci docs (#4723) --- services/wercker/wercker.service.js | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/services/wercker/wercker.service.js b/services/wercker/wercker.service.js index b72dbd3650..cd25d2a94c 100644 --- a/services/wercker/wercker.service.js +++ b/services/wercker/wercker.service.js @@ -14,6 +14,24 @@ const werckerSchema = Joi.array() .max(1) .required() +const werckerCIDocumentation = ` +

+ Note that Wercker badge Key (used in Wercker's native badge urls) is not the same as + the Application Id and the badge key will not work. +

+

+ You can use the Wercker API to locate your Application Id: +
+
+ https://app.wercker.com/api/v3/applications/:username/:applicationName +
+ For example: https://app.wercker.com/api/v3/applications/wercker/go-wercker-api +
+
+ Your Application Id will be in the 'id' field in the API response. +

+` + module.exports = class Wercker extends BaseJsonService { static get category() { return 'build' @@ -35,6 +53,7 @@ module.exports = class Wercker extends BaseJsonService { pattern: 'ci/:applicationId', namedParams: { applicationId: '559e33c8e982fc615500b357' }, staticPreview: this.render({ result: 'passed' }), + documentation: werckerCIDocumentation, }, { title: `Wercker CI Run`, @@ -44,6 +63,7 @@ module.exports = class Wercker extends BaseJsonService { branch: 'master', }, staticPreview: this.render({ result: 'passed' }), + documentation: werckerCIDocumentation, }, { title: `Wercker Build`,