Skip to content

Docs.MS Release Updates for azure-template #819

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
azure-sdk wants to merge 1 commit into from
Closed

Docs.MS Release Updates for azure-template #819

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions ci-configs/packages-latest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -523,6 +523,9 @@
},
{
"name": "@azure/arm-appplatform"
},
{
"name": "@azure/template"
}
],
"source_repos": []
Expand Down
42 changes: 42 additions & 0 deletions docs-ref-services/template-readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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