Skip to content
This repository has been archived by the owner on Nov 16, 2023. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tpetchel authored Oct 29, 2019
1 parent 03a399c commit 6fde380
Showing 1 changed file with 20 additions and 21 deletions.
41 changes: 20 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,17 @@ page_type: sample
languages:
- csharp
products:
- azure
- azure-devops
- dotnet
description: "Add 150 character max description"
urlFragment: "update-this-to-unique-url-stub"
description: "This repository contains starter code for the Automate your deployments with infrastructure as code learning path on Microsoft Learn."
urlFragment: "devops-automate"
---

# Official Microsoft Sample

This sample is not yet ready. Please check back soon for details!

<!--
Guidelines on README format: https://review.docs.microsoft.com/help/onboard/admin/samples/concepts/readme-template?branch=master
Expand All @@ -18,37 +22,32 @@ Guidance on onboarding samples to docs.microsoft.com/samples: https://review.doc
Taxonomies for products and languages: https://review.docs.microsoft.com/new-hope/information-architecture/metadata/taxonomies?branch=master
-->

Give a short description for your sample here. What does it do and why is it important?

## Contents

Outline the file contents of the repository. It helps users navigate the codebase, build configuration and any related assets.

| File/folder | Description |
|-------------------|--------------------------------------------|
| `src` | Sample source code. |
| `.gitignore` | Define what to ignore at commit time. |
| `CHANGELOG.md` | List of changes to the sample. |
| `CONTRIBUTING.md` | Guidelines for contributing to the sample. |
| `README.md` | This README file. |
| `LICENSE` | The license for the sample. |
| File/folder | Description |
|--------------------------|-------------|
| `Tailspin.SpaceGame.Web` | Application source code.|
| `.gitignore` | Defines what to ignore at commit time. |
| `CODE_OF_CONDUCT.md` | Microsoft Open Source Code of Conduct. |
| `README.md` | This README file. |
| `LICENSE` | The license for the sample. |
| `SECURITY.md` | Guidelines for reporting security issues. |

## Prerequisites

Outline the required components and tools that a user might need to have on their machine in order to run the sample. This can be anything from frameworks, SDKs, OS versions or IDE releases.
- An Azure subscription
- An Azure DevOps account
- Visual Studio Code
- .NET Core 2.1
- Git
- A GitHub account

## Setup

Explain how to prepare the sample once the user clones or downloads the repository. The section should outline every step necessary to install dependencies and set up any settings (for example, API keys and output folders).

## Runnning the sample

Outline step-by-step instructions to execute the sample and see its output. Include steps for executing the sample from the IDE, starting specific services in the Azure portal or anything related to the overall launch of the code.

## Key concepts

Provide users with more context on the tools and services used in the sample. Explain some of the code that is being used and how services interact with each other.

## Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a
Expand Down

0 comments on commit 6fde380

Please sign in to comment.