From cece720f47ede224a25ca0fe4063507edee6775c Mon Sep 17 00:00:00 2001 From: Eric Jimenez Date: Thu, 28 Jul 2016 10:29:03 -0400 Subject: [PATCH] output an audit file to keep track of documentation progress on API --- tools/api-builder/angular.io-package/index.js | 6 ++++++ .../templates/api-list-audit.template.html | 15 +++++++++++++++ 2 files changed, 21 insertions(+) create mode 100644 tools/api-builder/angular.io-package/templates/api-list-audit.template.html diff --git a/tools/api-builder/angular.io-package/index.js b/tools/api-builder/angular.io-package/index.js index 9f59e99221..4f4121ad7c 100644 --- a/tools/api-builder/angular.io-package/index.js +++ b/tools/api-builder/angular.io-package/index.js @@ -135,6 +135,12 @@ module.exports = new Package('angular.io', [basePackage, targetPackage, cheatshe pathTemplate: 'api-list.json', outputPathTemplate: '${path}' }); + + computePathsProcessor.pathTemplates.push({ + docTypes: ['api-list-data'], + pathTemplate: 'api-list-audit.json', + outputPathTemplate: '${path}' + }); computePathsProcessor.pathTemplates.push({ docTypes: ['cheatsheet-data'], diff --git a/tools/api-builder/angular.io-package/templates/api-list-audit.template.html b/tools/api-builder/angular.io-package/templates/api-list-audit.template.html new file mode 100644 index 0000000000..92fe2fcbec --- /dev/null +++ b/tools/api-builder/angular.io-package/templates/api-list-audit.template.html @@ -0,0 +1,15 @@ +[{% for module, items in doc.data %} + {% for item in items %} + { + "title": "{$ item.title $}", + "path": "{$ item.exportDoc.path $}", + "docType": "{$ item.docType $}", + "stability": "{$ item.stability $}", + "secure": "{$ item.security $}", + "howToUse": "{$ item.howToUse $}", + "whatItDoes": {% if item.whatItDoes %}"Exists"{% else %}"Not Done"{% endif %}, + "barrel" : "{$ module | replace("/index", "") $}" + }{% if not loop.last %},{% endif %} + {% endfor %} + {% endfor %} +] \ No newline at end of file