doc'd fairfax param files

martdob · Jan 8, 2020 · 29e7dd4 · 29e7dd4
1 parent 7ada07d
commit 29e7dd4
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 2 deletions.
diff --git a/1-CONTRIBUTION-GUIDE/README.md b/1-CONTRIBUTION-GUIDE/README.md
@@ -159,7 +159,28 @@ A valid metadata.json must adhere to the following structure
 
 ## Cloud Support
 
-If the sample does not support all clouds add the environments property to metadata.json indicating the clouds that are supported.
+If the sample does not support all clouds add the environments property to metadata.json indicating the clouds that are supported.  If omitted, the following is the default value of the environments property.
+
+```json
+{
+  ...
+  "environments": [
+    "AzureCloud",
+    "AzureUSGovernment"
+  ]
+}
+```
+
+### Cloud Specific Parameter Files
+
+If the sample needs separate parameter files for each cloud you can add each to the sample:
+
+| Cloud       | Parameter Filename |
+|:---------------------------------------- |:---------------------------------------- |
+| Azure Public Cloud  | azuredeploy.parameters.json |  
+| Azure US Government Cloud | azuredeploy.parameters.us.json |  
+
+If only one is provided it will be used for testing in all clouds.
 
 ## Azure DevOps CI
 

diff --git a/1-CONTRIBUTION-GUIDE/best-practices.md b/1-CONTRIBUTION-GUIDE/best-practices.md
@@ -32,7 +32,8 @@ An Azure Application or QuickStart sample must contain, at a minimum, the follow
 |:---------------------------------------- |:----------------------------------------------------- |:---------------------------------------- |
 | UI Definition File    | createUiDefinition.json | n/a |  
 | Template File | mainTemplate.json | azuredeploy.json |  
-| Parameters File | n/a | azuredeploy.parameters.json |  
+| Parameters File (Public) | n/a | azuredeploy.parameters.json  |  
+| Parameters File (US Gov) | n/a | azuredeploy.parameters.us.json |
 | Read Me File | Not required | README.md |  
 | [SECURITY.md file](https://help.github.com/en/articles/adding-a-security-policy-to-your-repository) | Not required | SECURITY.md |
 | QuickStart Description | n/a | metadata.json |