docs: update

Azure · Feb 18, 2025 · bb5bba8 · bb5bba8
1 parent 4dabb01
commit bb5bba8
Show file tree

Hide file tree

Showing 2 changed files with 67 additions and 63 deletions.
diff --git a/docs/wara/Start-WARAAnalyzer.md b/docs/wara/Start-WARAAnalyzer.md
@@ -1,3 +1,9 @@
+---
+external help file: wara-help.xml
+Module Name: wara
+online version: https://github.com/Azure/Azure-Proactive-Resiliency-Library-v2
+schema: 2.0.0
+---
 
 # Start-WARAAnalyzer
 
@@ -7,54 +13,29 @@ Well-Architected Reliability Assessment Script
 ## SYNTAX
 
 ```
-Start-WARAAnalyzer [-Debugging] [-Help] [[-CustomRecommendationsYAMLPath] <String>] [[-RepoUrl] <String>]
- [-JSONFile] <String> [-ProgressAction <ActionPreference>] [<CommonParameters>]
+Start-WARAAnalyzer [[-RecommendationsUrl] <String>] [-JSONFile] <String> [[-ExpertAnalysisFile] <String>]
+ [-ProgressAction <ActionPreference>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
-The function \`Start-WARAAnalyzer\` will process the JSON file created by the \`Start-WARACollector\` function and will create the core WARA Action Plan Excel file.
+The function `Start-WARAAnalyzer` will process the JSON file created by the \`Start-WARACollector\` function and will create the core WARA Action Plan Excel file.
 
 ## EXAMPLES
 
 ### EXAMPLE 1
+```Powershell
+Start-WARAAnalyzer -JSONFile 'C:\Temp\WARA_File_2024-04-01_10_01.json'
 ```
-Start-WARAAnalyzer -JSONFile 'C:\Temp\WARA_File_2024-04-01_10_01.json' -Debugging
-```
-
-## PARAMETERS
-
-### -Debugging
-Switch to enable debugging mode.
-
-```yaml
-Type: SwitchParameter
-Parameter Sets: (All)
-Aliases:
 
-Required: False
-Position: Named
-Default value: False
-Accept pipeline input: False
-Accept wildcard characters: False
+### EXAMPLE 2
+```Powershell
+Start-WARAAnalyzer -JSONFile 'C:\Temp\WARA_File_2024-04-01_10_01.json' -Debug
 ```
 
-### -Help
-Switch to display help information.
-
-```yaml
-Type: SwitchParameter
-Parameter Sets: (All)
-Aliases:
-
-Required: False
-Position: Named
-Default value: False
-Accept pipeline input: False
-Accept wildcard characters: False
-```
+## PARAMETERS
 
-### -CustomRecommendationsYAMLPath
-{{ Fill CustomRecommendationsYAMLPath Description }}
+### -RecommendationsUrl
+This is the URL to the JSON file that contains the recommendations. The default value is the URL to the recommendations object stored at https://azure.github.io/WARA-Build/objects/recommendations.json
 
 ```yaml
 Type: String
@@ -63,22 +44,7 @@ Aliases:
 
 Required: False
 Position: 1
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
-### -RepoUrl
-Specifies the git repository URL that contains APRL contents if you want to use custom APRL repository.
-
-```yaml
-Type: String
-Parameter Sets: (All)
-Aliases:
-
-Required: False
-Position: 2
-Default value: Https://github.com/Azure/Azure-Proactive-Resiliency-Library-v2
+Default value: Https://azure.github.io/WARA-Build/objects/recommendations.json
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
@@ -92,22 +58,22 @@ Parameter Sets: (All)
 Aliases:
 
 Required: True
-Position: 3
+Position: 2
 Default value: None
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -ProgressAction
-{{ Fill ProgressAction Description }}
+### -ExpertAnalysisFile
+This is the path to the ExpertAnalysisTemplate file. It is packaged with the module and generally you should not need to adjust this.
 
 ```yaml
-Type: ActionPreference
+Type: String
 Parameter Sets: (All)
-Aliases: proga
+Aliases:
 
 Required: False
-Position: Named
+Position: 3
 Default value: None
 Accept pipeline input: False
 Accept wildcard characters: False

diff --git a/docs/wara/Start-WARAReport.md b/docs/wara/Start-WARAReport.md
@@ -1,3 +1,9 @@
+---
+external help file: wara-help.xml
+Module Name: wara
+online version: https://github.com/Azure/Azure-Proactive-Resiliency-Library-v2
+schema: 2.0.0
+---
 
 # Start-WARAReport
 
@@ -7,7 +13,9 @@ Well-Architected Reliability Assessment Report Generator Function
 ## SYNTAX
 
 ```
-Start-WARAReport [-Help] [-Debugging] [[-CustomerName] <String>] [[-WorkloadName] <String>] [-ExpertAnalysisFile] <String> [<CommonParameters>]
+Start-WARAReport [-Help] [-includeLow] [[-CustomerName] <String>] [[-WorkloadName] <String>]
+ [-ExpertAnalysisFile] <String> [[-AssessmentFindingsFile] <String>] [[-PPTTemplateFile] <String>]
+ [-ProgressAction <ActionPreference>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -16,7 +24,7 @@ The function \`Start-WARAReport\` processes the Excel file created by the \`Star
 ## EXAMPLES
 
 ### EXAMPLE 1
-```
+```Powershell
 Start-WARAReport -ExpertAnalysisFile 'C:\WARA_Script\WARA Action Plan 2024-03-07_16_06.xlsx' -CustomerName 'ABC Customer' -WorkloadName 'SAP On Azure'
 ```
 
@@ -37,8 +45,8 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -Debugging
-Switch to enable debugging mode.
+### -includeLow
+Option to also consider Low Impact recommendations.
 
 ```yaml
 Type: SwitchParameter
@@ -88,7 +96,7 @@ Path to the Excel file created by the "2_wara_data_analyzer" script.
 ```yaml
 Type: String
 Parameter Sets: (All)
-Aliases:
+Aliases: ExcelFile
 
 Required: True
 Position: 3
@@ -97,6 +105,36 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -AssessmentFindingsFile
+Path to the Assessment Findings file.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: 4
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -PPTTemplateFile
+Path to the PowerPoint template file.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: 5
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### CommonParameters
 This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).