diff --git a/ci-configs/packages-latest.json b/ci-configs/packages-latest.json index dd37a1ff8dda..8d3eac57598f 100644 --- a/ci-configs/packages-latest.json +++ b/ci-configs/packages-latest.json @@ -523,6 +523,9 @@ }, { "name": "@azure/arm-appplatform" + }, + { + "name": "@azure/template" } ], "source_repos": [] diff --git a/docs-ref-services/template-readme.md b/docs-ref-services/template-readme.md new file mode 100644 index 000000000000..fed8512a23ac --- /dev/null +++ b/docs-ref-services/template-readme.md @@ -0,0 +1,42 @@ +--- +title: Azure Template client library for JavaScript +keywords: Azure, javascript, SDK, API, @azure/template, +author: maggiepint +ms.author: magpint +ms.date: 09/03/2020 +ms.topic: article +ms.prod: azure +ms.technology: azure +ms.devlang: javascript +ms.service: +--- + +## Azure Template client library for JavaScript - Version 1.0.8 + + +This template serves as a starting point for JavaScript libraries targeting both Node and the Browser and implemented in TypeScript. + +**Note:** +For a more complete example of README.md file, please see [README template][readme_template]. Also see the [Azure SDK Document Guidelines][azsdk_doc_guidelines] for more information. + +## Building the Template + +Please refer to the [Contributing Guide][contributing_guide] for information on how to build projects in this repository. + +## Implementation Details + +The overall build pipeline looks like the following: + +1. TypeScript builds all source files under `./src` to ECMAScript Modules (ESM) under `./dist-esm`. +2. Rollup builds `./dist-esm` to an optimized single file at `./dist/index.js` as the Node entry point. +3. Rollup builds `./dist-esm` to an optimized browser bundle under `./browser/azure-template.js`. + +Tests follow a similar pipeline, however test output is under `dist-test` folder. + + +![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Ftemplate%2Ftemplate%2FREADME.png) + +[readme_template]: https://github.com/Azure/azure-sdk-for-js/blob/@azure/template_1.0.8/sdk/template/template/README-TEMPLATE.md +[azsdk_doc_guidelines]: https://review.docs.microsoft.com/en-us/help/contribute-ref/contribute-ref-how-to-document-sdk?branch=master#readme +[contributing_guide]: https://github.com/Azure/azure-sdk-for-js/blob/@azure/template_1.0.8/CONTRIBUTING.md +