From d8ae10285754ca4ea454278c40ee419071148ac2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sebastian=20Sch=C3=BCtze?=
 <sebastian.schuetze@razorspoint.com>
Date: Wed, 26 Feb 2020 08:20:18 +0100
Subject: [PATCH] adding documentation

---
 .docs/Test-VSTeamYamlPipeline.md          | 68 +++++++++++++++++++++++
 .docs/synopsis/Test-VSTeamYamlPipeline.md |  1 +
 2 files changed, 69 insertions(+)
 create mode 100644 .docs/Test-VSTeamYamlPipeline.md
 create mode 100644 .docs/synopsis/Test-VSTeamYamlPipeline.md

diff --git a/.docs/Test-VSTeamYamlPipeline.md b/.docs/Test-VSTeamYamlPipeline.md
new file mode 100644
index 000000000..cc20f71f1
--- /dev/null
+++ b/.docs/Test-VSTeamYamlPipeline.md
@@ -0,0 +1,68 @@
+<!-- #include "./common/header.md" -->
+
+# Test-VSTeamMembership
+
+## SYNOPSIS
+
+<!-- #include "./synopsis/Test-VSTeamYamlPipeline.md" -->
+
+## SYNTAX
+
+## DESCRIPTION
+
+<!-- #include "./synopsis/Test-VSTeamYamlPipeline.md" -->
+
+## EXAMPLES
+
+### -------------------------- EXAMPLE 1 --------------------------
+
+```PowerShell
+PS C:\> Test-VSTeamYamlPipeline -Project DemoProject -PipelineId 24 -FilePath './azure-pipelines.yml'
+
+Build Definition Build Number  Status     Result
+---------------- ------------  ------     ------
+Demo-CI           Demo-CI-45   notStarted
+```
+
+This example checks the YAML pipeline with ID 24 and the file './azure-pipelines.yml' for consistency on Azure DevOps to see if the changes still work.
+
+## PARAMETERS
+
+<!-- #include "./params/projectName.md" -->
+
+### -PipelineId
+
+Id of the YAML pipeline to be checked
+
+```yaml
+Type: Int32
+Position: 1
+```
+
+### -FilePath
+
+Path to the file that should be checked
+
+```yaml
+Type: String
+```
+
+## INPUTS
+
+### System.String
+
+FilePath
+
+### System.Int32
+
+PipelineId
+
+## OUTPUTS
+
+### Team.YamlPipelineResult
+
+## NOTES
+
+If you do not set the default project by called Set-VSTeamDefaultProject before calling Add-VSTeamBuild you will have to type in the names.
+
+## RELATED LINKS
diff --git a/.docs/synopsis/Test-VSTeamYamlPipeline.md b/.docs/synopsis/Test-VSTeamYamlPipeline.md
new file mode 100644
index 000000000..7119b9e00
--- /dev/null
+++ b/.docs/synopsis/Test-VSTeamYamlPipeline.md
@@ -0,0 +1 @@
+Tests the commited YAML pipeline files to check for inconsitencies.
\ No newline at end of file