update doc

Covid-19Radar · Jul 3, 2020 · 3f5d903 · 3f5d903
1 parent e00fa3e
commit 3f5d903
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 117 deletions.
diff --git a/doc/HOT_TO_CREATE_DEV_ENV.md b/doc/HOT_TO_CREATE_DEV_ENV.md
@@ -98,7 +98,7 @@ https://github.com/Azure/Azure-Functions
 
 More info
 
-- [Easy step by step for functions development](./step-by-step-for-functions-development.md)
+- [Easy step by step for functions development](HOW_TO_BUILD_SERVER_SIDE.md)
 - [Infrastructure デプロイメントスクリプト](../infrastructure/Readme.md)
 
 # References

diff --git a/...step-by-step-for-functions-development.md → doc/HOW_TO_BUILD_SERVER_SIDE.md b/...step-by-step-for-functions-development.md → doc/HOW_TO_BUILD_SERVER_SIDE.md
@@ -31,3 +31,5 @@ any thing.
 ```
 
 ## 4. build and Debug
+
+Ctrl + Alt + B / F5 Key
diff --git a/doc/HOW_TO_USE_YOUR_COUNTRY.md b/doc/HOW_TO_USE_YOUR_COUNTRY.md
@@ -1,3 +1,4 @@
+
 # If you want to use this in your country
 Apple and Google place restrictions on the use of this API by public health authorities only.
 Therefore, you should contact Google and Apple through public health authorities.
@@ -156,7 +157,42 @@ Please refer to the following XAML code.
 
 ```
 
+### App-specific value
+The required values for this application can be found in Covid19Radar/settings.json.
+
+```
+{
+  "appVersion": "APP_VERSION",
+  "apiSecret": "API_SECRET",
+  "apiUrlBase": "https://API_URL_BASE/api",
+  "supportedRegions": "999",
+  "blobStorageContainerName": "c19r",
+  "androidSafetyNetApiKey": "ANDROID_SAFETYNETKEY",
+  "cdnUrlBase": "https://CDN_URL_BASE/",
+  "licenseUrl": "https://SOFTWARELICENSE_URL/",
+  "appStoreUrl": "https://YOUR_APP_STORE_URL",
+  "googlePlayUrl": "https://YOUR_GOOGLE_PLAY_URL",
+  "supportEmail": "SUPPORT_EMAIL"
+}
+```
+
+|  Name  |  Exsample Value  | Description  |
+| ---- | ---- | ---- | ---- |
+|  appVersion  |  Ver1.0  | Application version notation  |
+|  apiSecret  |  Azure Functions API Host Key  | Azure Function API host API key  |
+|  apiUrlBase  |  https://localhost:8081/api  | Server-side Azure Functions API endpoint URL,Please include up to /api.  |
+|  supportedRegions  |  999  | MCC (Mobile Country Code). In the specification of Exposure Notification, use any value in each region. https://en.wikipedia.org/wiki/Mobile_country_code |
+|  blobStorageContainerName  |  containername  | Azure Storage container name that stores files generated by batch processing of azure functions.  |
+|  androidSafetyNetApiKey  |  ANDROID_SAFETYNETKEY_BASE64  | API key by google safetynet api.  |
+|  cdnUrlBase  |  https://CDN_URL_BASE/  | An Azure Storage endpoint generated by an Azure Functions batch.CDN endpoint for CDN caching.  |
+|  licenseUrl  |  https://CDN_URL_BASE/  | It is displayed as it is on the URL and WebView for the license notation.  |
+|  appStoreUrl  |  https://CDN_URL_BASE/  | It is used when sharing the URL of the App Store and the download URL of the application.  |
+|  googlePlayUrl  |  https://CDN_URL_BASE/  | It is used when sharing the URL of GooglePlay and the download URL of the application.  |
+|  supportEmail  |  SUPPORT_EMAIL  | Often this app will need support center emails or some kind of support. This is your email address.  |
+
+
 ## Server Side Architecture / Automation CI,CD
 
 see this doc
+https://github.com/Covid-19Radar/Covid19Radar/blob/master/doc/HOW_TO_BUILD_SERVER_SIDE.md
 https://github.com/Covid-19Radar/Covid19Radar/blob/master/doc/SERVER_SIDE_ARCHITECTURE.md
diff --git a/doc/Knowledge-Base.md b/doc/Knowledge-Base.md
diff --git a/doc/domain-model.md b/doc/domain-model.md
Original file line number	Diff line number	Diff line change
Expand Up		@@ -31,3 +31,5 @@ any thing.
		```

		## 4. build and Debug

		Ctrl + Alt + B / F5 Key