Merge pull request #59 from dereklegenzoff/delegenz

Small doc updates

Author: Derek Legenzoff

00 - Resource Deployment/README.md

@@ -26,6 +26,7 @@ There are two options for deploying the resources to Azure for this solution acc
 ## Prerequisites
 
 1. Access to an Azure Subscription
+2. If you're running the PowerShell script, you'll also need to install the [Az PowerShell Module](https://docs.microsoft.com/powershell/azure/install-az-ps)
 
 ## Running the PowerShell Script
 
@@ -34,10 +35,15 @@ There are two options for deploying the resources to Azure for this solution acc
 To run the [PowerShell script](./deploy.ps1):
 
 1. Open PowerShell and navigate to this folder.
+
+    ```cmd
+    cd "00 - Resource Deployment"
+    ```
+
 2. Run the following command:
 
     ```cmd
-        ./deploy.ps1
+    ./deploy.ps1
     ```
 
 3. After running the script, you'll be prompted to login and provide additional information.

00 - Resource Deployment/deploy.ps1

@@ -33,6 +33,7 @@ function Deploy
 {
     # Read parameters from user.
     Write-Host "Press enter to use [default] value."
+    Write-Host "For uniqueName, please enter a string with 10 or less characters."
     while (!($uniqueName = Read-Host "uniqueName")) { Write-Host "You must provide a uniqueName."; }
     while (!($resourceGroupName = Read-Host "resourceGroupName")) { Write-Host "You must provide a resourceGroupName."; }
     while (!($subscriptionId = Read-Host "subscriptionId")) { Write-Host "You must provide a subscriptionId."; }
@@ -47,7 +48,7 @@ function Deploy
     $webappname = $uniqueName + "app";
     $cogServicesName = $uniqueName + "cog";
     $appInsightsName = $uniqueName + "insights";
-    $storageAccountName = $uniqueName + "storage";
+    $storageAccountName = $uniqueName + "str";
     $storageContainerName = "documents";
 
     $dataSourceName = $uniqueName + "-datasource";

01 - Search Index Creation/Create-Index-PowerShell.md

@@ -9,7 +9,7 @@ The following code will create a search index for you based on the json files in
 
     # Generate derivative parameters.
     $searchServiceName = $uniqueName + "search";
-    $storageAccountName = $uniqueName + "storage";
+    $storageAccountName = $uniqueName + "str";
     $storageContainerName = "documents";
 
     $dataSourceName = $uniqueName + "-datasource";
@@ -71,17 +71,26 @@ The following code will create a search index for you based on the json files in
     CreateSearchIndex;
 ```
 
+## Prerequisites
+
+2. To run the PowerShell script, you'll need to install the [Az PowerShell Module](https://docs.microsoft.com/powershell/azure/install-az-ps)
+
 ## Running the PowerShell Script
 
 > If you're new to PowerShell, you can follow the instructions on [How to run PowerShell script file on Windows 10](https://www.windowscentral.com/how-create-and-run-your-first-powershell-script-file-windows-10) to help you get started.
 
 To run the [PowerShell script](./deploy.ps1):
 
 1. Open PowerShell and navigate to this folder.
+
+    ```cmd
+    cd "00 - Resource Deployment"
+    ```
+
 2. Run the following command:
 
     ```cmd
-        ./deploy.ps1
+    ./deploy.ps1
     ```
 
-3. After running the script, you'll be prompted to login and provide additional information.
+3. After running the script, you'll be prompted to login and provide additional information.

README.md

@@ -47,48 +47,54 @@ Clone or download this repository and then navigate through each of these folder
 
 ![the cognitive indexing pipelines used for processing unstructured data in Azure Search](images/architecture.jpg)
 
-### [00 - Resource Deployment](./00%20-%20Resource%20Deployment)
-The contents of this folder show you how to deploy the required resources to your Azure subscription. You can do this either through the [Azure portal](https://portal.azure.com) or using the provided [PowerShell script](./00%20-%20Resource%20Deployment/deploy.ps1).
+### [00 - Resource Deployment](https://github.com/Azure-Samples/azure-search-knowledge-mining/00%20-%20Resource%20Deployment)
+
+The contents of this folder show you how to deploy the required resources to your Azure subscription. You can do this either through the [Azure portal](https://portal.azure.com) or using the provided [PowerShell script](https://github.com/Azure-Samples/azure-search-knowledge-mining/00%20-%20Resource%20Deployment/deploy.ps1).
 
 Alternatively, you can automatically deploy the required resources using this button:
 
 <a href="https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure-Samples%2Fazure-search-knowledge-mining%2Fmaster%2Fazuredeploy.json" target="_blank">
     <img src="http://azuredeploy.net/deploybutton.png"/>
-</a> 
+</a>
+
+### [01 - Search Index Creation](https://github.com/Azure-Samples/azure-search-knowledge-mining/01%20-%20Search%20Index%20Creation)
 
-### [01 - Search Index Creation](./01%20-%20Search%20Index%20Creation)
 This folder contains a Postman collection that you can use to create a search index. The collection is pre-configured to take advantage of out-of-the-box Cognitive Search functionality.
 
 We recommend using this collection to create an initial search index and then iterating by editing the postman collection and adding custom skills as needed.
 
-### [02 - Web UI Template](./02%20-%20Web%20UI%20Template)
-This folder contains a basic Web UI Template, written in .NET Core, which you can configure to query your search index. Follow the steps outlined in the [Web UI Template README file](./02%20-%20Web%20UI%20Template/README.md) to integrate your new search index into the web app.
+### [02 - Web UI Template](https://github.com/Azure-Samples/azure-search-knowledge-mining/02%20-%20Web%20UI%20Template)
+
+This folder contains a basic Web UI Template, written in .NET Core, which you can configure to query your search index. Follow the steps outlined in the [Web UI Template README file](https://github.com/Azure-Samples/azure-search-knowledge-mining/02%20-%20Web%20UI%20Template/README.md) to integrate your new search index into the web app.
+
+### [03 - Data Science & Custom Skills](https://github.com/Azure-Samples/azure-search-knowledge-mining/03%20-%20Data%20Science%20and%20Custom%20Skills)
 
-### [03 - Data Science & Custom Skills](./03%20-%20Data%20Science%20and%20Custom%20Skills)
 This folder contains examples and templates to add your own custom skills to your solution. These custom skills help to align the solution to the needs of your particular use case. This step is entirely optional and may be skipped if not needed.
 
 For additional samples and information on custom skill development, see the [Custom skill documentation](https://docs.microsoft.com/azure/search/cognitive-search-custom-skill-interface). .NET Azure Function Custom Skills have moved to the [Power Skills repository](https://github.com/Azure-Samples/azure-search-power-skills).
 
-### [04 - Reporting](./04%20-%20Reporting)
+### [04 - Reporting](https://github.com/Azure-Samples/azure-search-knowledge-mining/04%20-%20Reporting)
+
 This folder contains pre-built PowerBI reports that you can use to monitor your solution and to understand user search behavior. They leverage data captured through [Application Insights](https://docs.microsoft.com/azure/azure-monitor/app/app-insights-overview) and can be modified to meet your particular business objectives. This step is entirely optional and may be skipped if not needed.
 
-### [Sample Documents](./sample_documents)
+### [Sample Documents](https://github.com/Azure-Samples/azure-search-knowledge-mining/sample_documents)
+
 This folder contains a small data set in a variety of file formats that you can use to build your solution if you don't have another data set available.
 
-### [Workshop](./workshops)
+### [Workshop](https://github.com/Azure-Samples/azure-search-knowledge-mining/workshops)
+
 Become an Azure Cognitive Search expert in a day!
 This folder contains a self paced workshop that teaches you everything you need to know. Most developer with Azure familiarity should be able to complete the majority of the modules below in 8 hours.
 
-+ [Module 0 - Pre-Requisites](./workshops/Module%200.md) (*you must complete prior to moving on!*)
-+ [Module 1 - Using Azure Portal to Build a Search Index and Knowledge Store](./workshops/Module%201.md)
-+ [Module 2 - Visualizing the Results with a Demo FrontEnd](./workshops/Module%202.md)
-+ [Module 3 - Introduction to Custom Skills and Azure Functions](./workshops/Module%203.md)
-+ [Module 4 - Learning the Object Model](./Module%204.md)
-+ [Module 5 - Advanced Azure Cognitive Search: Analyzers and Scoring Profiles](./workshops/Module%205.md)
-+ [Module 6 - Analyzing Your Data with PowerBI](./workshops/Module%206.md)
++ [Module 0 - Pre-Requisites](https://github.com/Azure-Samples/azure-search-knowledge-mining/workshops/Module%200.md) (*you must complete prior to moving on!*)
++ [Module 1 - Using Azure Portal to Build a Search Index and Knowledge Store](https://github.com/Azure-Samples/azure-search-knowledge-mining/workshops/Module%201.md)
++ [Module 2 - Visualizing the Results with a Demo FrontEnd](https://github.com/Azure-Samples/azure-search-knowledge-mining/workshops/Module%202.md)
++ [Module 3 - Introduction to Custom Skills and Azure Functions](https://github.com/Azure-Samples/azure-search-knowledge-mining/workshops/Module%203.md)
++ [Module 4 - Learning the Object Model](https://github.com/Azure-Samples/azure-search-knowledge-mining/Module%204.md)
++ [Module 5 - Advanced Azure Cognitive Search: Analyzers and Scoring Profiles](https://github.com/Azure-Samples/azure-search-knowledge-mining/workshops/Module%205.md)
++ [Module 6 - Analyzing Your Data with PowerBI](https://github.com/Azure-Samples/azure-search-knowledge-mining/workshops/Module%206.md)
 + [Module 7 - Using Azure Cognitive Search to index structured data](./workshops/Module%207.md) (Optional)
 
-
 ## License
 
-Please refer to [LICENSE](./LICENSE.md) for all licensing information.
+Please refer to [LICENSE](https://github.com/Azure-Samples/azure-search-knowledge-mining/LICENSE.md) for all licensing information.

azuredeploy.json

@@ -89,7 +89,7 @@
     },
     "variables": {
         "hostingPlanName": "[concat(parameters('resourcePrefix'), '-plan')]",
-        "storageAccountName": "[concat(parameters('resourcePrefix'), 'storage')]",
+        "storageAccountName": "[concat(parameters('resourcePrefix'), 'str')]",
         "websiteName": "[concat(parameters('resourcePrefix'), '-site')]",
         "appInsightsName": "[concat(parameters('resourcePrefix'), '-app-insights')]",
         "searchServiceName": "[concat(parameters('resourcePrefix'), '-search-service')]",