Skip to content

Latest commit

 

History

History
44 lines (33 loc) · 4.05 KB

README.md

File metadata and controls

44 lines (33 loc) · 4.05 KB
Raw

Azure Managed Application samples

This repository contains all currently available Azure Managed Application samples contributed by the community. The following information is relevant to get started with contributing to this repository.

  • Contribution guide. Describes the minimal guidelines for contributing.
  • Best practices. Best practices for improving the quality of Azure Managed Application design.
  • Git tutorial. Step by step to get you started with Git.
  • Useful Tools. Useful resources and tools for Azure development.

Contribution guide

To make sure your Managed Application sample is added to this repository, please follow these guidelines. Any Managed Application sample that are out of compliance will be added to the blacklist and not be merged.

Files, folders and naming conventions

  1. Every Managed Application sample its associated files must be contained in its own folder. Name this folder so it represents what your Managed Application does. Usually this naming pattern looks like appName-osName or level-platformCapability (e.g. 101-managed-storage)
  • Required - Numbering should start at 101. 100 is reserved for things that need to be at the top.
  • Protip - Try to keep the name of your template folder short so that it fits inside the Github folder name column width.
  1. Github uses ASCII for ordering files and folder. For consistent ordering create all files and folders in lowercase. The only exception to this guideline is the README.md, that should be in the format UPPERCASE.lowercase.
  2. Include a README.md file that explains how the Managed Application works, and how to deploy.
  • Guidelines on the README.md file below.
  1. A Managed Application needs to include the following files:
  • mainTemplate.json - The Resource Manager template that will deploy resources (and nested templates)
  • createUiDefinition.json - The user interface definition file, to generate input parameters to the customer facing template in the Azure portal
  • A generalized .zip file with all the artifacts for the Managed Application.
  1. The custom scripts that are needed for successful template execution must be placed in a sub-folder called scripts.
  2. Linked templates must be placed in a sub-folder called nestedtemplates.
  3. Images used in the README.md must be placed in a folder called images.
  4. an azuredeploy.json template which will create and initialize the Managed Application offering directly in the Azure subscription, referencing the artifacts in the reposotiry.

alt text

README.md

The README.md describes your deployment. A good description helps other community members to understand your deployment. The README.md uses Github Flavored Markdown for formatting text. If you want to add images to your README.md file, store the images in the images folder. Reference the images in the README.md with a relative path (e.g. ![alt text](images/namingConvention.png "Files, folders and naming conventions")). This ensures the link will reference the target repository if the source repository is forked. A good README.md contains the following sections

  • Deployment instructions
  • AzureDeploy/PowerShell/CLI example of automated import
  • Description of what the Managed Application will deploy
  • *Optional: Prerequisites
  • *Optional: Description on how to use the Managed Application
  • *Optional: Notes

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.