Cognitive Search - add search to website - .NET

diberry · diberry · commit b3047667cf55 · 2022-11-01T10:34:29.000-07:00
diff --git a/articles/search/includes/tutorial-add-search-website-load-index-copy-resource-name.md b/articles/search/includes/tutorial-add-search-website-load-index-copy-resource-name.md
@@ -0,0 +1,11 @@
+---
+ms.topic: include
+ms.date: 10/26/2022
+author: HeidiSteen
+ms.author: heidist
+ms.service: cognitive-search
+---
+Note your **Search resource name**. You'll need this to connect the Azure Function app to your Search resource. 
+
+> [!CAUTION]
+> While you may be tempted to use your Search admin key in the Azure Function, that isn't following the principle of least privilege. The Azure Function will use the query key to conform to least privilege. 
diff --git a/articles/search/includes/tutorial-add-search-website-load-index-review.md b/articles/search/includes/tutorial-add-search-website-load-index-review.md
@@ -0,0 +1,17 @@
+---
+ms.topic: include
+ms.date: 10/26/2022
+author: HeidiSteen
+ms.author: heidist
+ms.service: cognitive-search
+---
+
+Once the upload completes, the Search Index is ready to use. Review your new Index.
+
+1. In Visual Studio Code, open the Azure Cognitive Search extension and select your Search resource.  
+
+    :::image type="content" source="../media/tutorial-javascript-create-load-index/visual-studio-code-search-extension-view-resource.png" alt-text="In Visual Studio Code, open the Azure Cognitive Search extension and open your Search resource.":::
+
+1. Expand Indexes, then Documents, then `good-books`, then select a doc to see all the document-specific data.
+ 
+    :::image type="content" source="../media/tutorial-javascript-create-load-index/visual-studio-code-search-extension-view-docs.png" lightbox="../media/tutorial-javascript-create-load-index/visual-studio-code-search-extension-view-docs.png" alt-text="Expand Indexes, then `good-books`, then select a doc.":::
diff --git a/articles/search/includes/tutorial-all-search-website-load-index-rollback-changes.md b/articles/search/includes/tutorial-all-search-website-load-index-rollback-changes.md
@@ -0,0 +1,12 @@
+---
+ms.topic: include
+ms.date: 10/26/2022
+author: HeidiSteen
+ms.author: heidist
+ms.service: cognitive-search
+---
+Use the following git command in the VS Code integrated terminal at the `bulk-insert` directory, to roll back the changes. They aren't needed to continue the tutorial and you shouldn't save or push these secrets to your repo. 
+
+```git
+git checkout .
+```
diff --git a/articles/search/tutorial-csharp-create-load-index.md b/articles/search/tutorial-csharp-create-load-index.md
@@ -7,16 +7,17 @@ author: diberry
 ms.author: diberry
 ms.service: cognitive-search
 ms.topic: tutorial
-ms.date: 08/30/2022
+ms.date: 11/01/2022
 ms.custom: devx-track-csharp
 ms.devlang: csharp
 ---
 
 # 2 - Create and load Search Index with .NET
 
 Continue to build your Search-enabled website by:
-* Creating a Search resource with the VS Code extension
-* Creating a new index and importing data with .NET using the sample script and Azure SDK [Azure.Search.Documents](https://www.nuget.org/packages/Azure.Search.Documents/).
+* Create a Search resource with the VS Code extension
+* Create a new index
+* Import data with .NET using the sample script and Azure SDK [Azure.Search.Documents](https://www.nuget.org/packages/Azure.Search.Documents/).
 
 ## Create an Azure Search resource 
 
@@ -26,7 +27,7 @@ Create a new Search resource with the [Azure Cognitive Search](https://marketpla
 
 1. In the Side bar, **right-click on your Azure subscription** under the `Azure: Cognitive Search` area and select **Create new search service**.
 
-    :::image type="content" source="./media/tutorial-javascript-create-load-index/visual-studio-code-create-search-resource.png" alt-text="In the Side bar, right-click on your Azure subscription under the **Azure: Cognitive Search** area and select **Create new search service**.":::
+    :::image type="content" source="./media/tutorial-javascript-create-load-index/visual-studio-code-create-search-resource.png" alt-text="Screenshot of Visual Studio code showing the Azure explorer bar, right-click on your Azure subscription under the Azure: Cognitive Search area and select Create new search service.":::
 
 1. Follow the prompts to provide the following information:
 
@@ -45,7 +46,7 @@ Get your Search resource admin key with the Visual Studio Code extension.
 
 1. In Visual Studio Code, in the Side bar, right-click on your Search resource and select **Copy Admin Key**.
 
-    :::image type="content" source="./media/tutorial-javascript-create-load-index/visual-studio-code-copy-admin-key.png" alt-text="In the Side bar, right-click on your Search resource and select **Copy Admin Key**.":::
+    :::image type="content" source="./media/tutorial-javascript-create-load-index/visual-studio-code-copy-admin-key.png" alt-text="Screenshot of Visual Studio code showing the Azure explorer bar, right-click on your Search resource and select Copy Admin Key.":::
 
 1. Keep this admin key, you will need to use it in [a later section](#prepare-the-bulk-import-script-for-search). 
 
@@ -86,11 +87,19 @@ Once the upload completes, the Search Index is ready to use. Review your new Ind
 
 1. In Visual Studio Code, open the Azure Cognitive Search extension and select your Search resource.  
 
-    :::image type="content" source="media/tutorial-javascript-create-load-index/visual-studio-code-search-extension-view-resource.png" alt-text="In Visual Studio Code, open the Azure Cognitive Search extension and open your Search resource.":::
+    :::image type="content" source="media/tutorial-javascript-create-load-index/visual-studio-code-search-extension-view-resource.png" alt-text="Screenshot of Visual Studio Code, open the Azure Cognitive Search extension and open your Search resource.":::
 
 1. Expand Indexes, then Documents, then `good-books`, then select a doc to see all the document-specific data.
  
-    :::image type="content" source="media/tutorial-javascript-create-load-index/visual-studio-code-search-extension-view-docs.png" lightbox="media/tutorial-javascript-create-load-index/visual-studio-code-search-extension-view-docs.png" alt-text="Expand Indexes, then `good-books`, then select a doc.":::
+    :::image type="content" source="media/tutorial-javascript-create-load-index/visual-studio-code-search-extension-view-docs.png" lightbox="media/tutorial-javascript-create-load-index/visual-studio-code-search-extension-view-docs.png" alt-text="Screenshot of Visual Studio Code showing Cognitive Search resource, expand Indexes, then `good-books`, then select a doc.":::
+
+## Rollback bulk import file changes
+
+Use the following git command in the VS Code integrated terminal at the `bulk-insert` directory, to rollback the changes. They are not needed to continue the tutorial and you shouldn't save or push these secrets to your repo. 
+
+```git
+git checkout .
+```
 
 ## Copy your Search resource name
 
@@ -99,13 +108,7 @@ Note your **Search resource name**. You will need this to connect the Azure Func
 > [!CAUTION]
 > While you may be tempted to use your Search admin key in the Azure Function, that isn't following the principle of least privilege. The Azure Function will use the query key to conform to least privilege. 
 
-## Rollback bulk import file changes
-
-Use the following git command in the VS Code integrated terminal at the `bulk-insert` directory, to rollback the changes. They are not needed to continue the tutorial and you shouldn't save or push these secrets to your repo. 
 
-```git
-git checkout .
-```
 
 ## Next steps
 
diff --git a/articles/search/tutorial-csharp-overview.md b/articles/search/tutorial-csharp-overview.md
@@ -7,7 +7,7 @@ author: diberry
 ms.author: diberry
 ms.service: cognitive-search
 ms.topic: tutorial
-ms.date: 08/30/2022
+ms.date: 11/01/2022
 ms.custom: devx-track-csharp
 ms.devlang: csharp
 ---
@@ -21,35 +21,25 @@ The application is available:
 * [Demo website - aka.ms/azs-good-books](https://aka.ms/azs-good-books)
 
 ## What does the sample do? 
-
-This sample website provides access to a catalog of 10,000 books. A user can search the catalog by entering text in the search bar. While the user enters text, the website uses the search index's suggest feature to complete the text. Once the query finishes, the list of books is displayed with a portion of the details. A user can select a book to see all the details, stored in the search index, of the book. 
-
-:::image type="content" source="./media/tutorial-javascript-overview/cognitive-search-enabled-book-website.png" alt-text="This sample website provides access to a catalog of 10,000 books. A user can search the catalog by entering text in the search bar. While the user enters text, the website uses the search index's suggest feature to complete the text. Once the search finishes, the list of books is displayed with a portion of the details. A user can select a book to see all the details, stored in the search index, of the book.":::
-
-The search experience includes: 
-
-* Search – provides search functionality for the application.
-* Suggest – provides suggestions as the user is typing in the search bar.
-* Document Lookup – looks up a document by ID to retrieve all of its contents for the details page.
+[!INCLUDE [tutorial-overview](includes/tutorial-add-search-website-what-sample-does.md)]
 
 ## How is the sample organized?
 
-The [sample](https://github.com/Azure-Samples/azure-search-dotnet-samples/tree/master/search-website) includes the following:
+The [sample](https://github.com/Azure-Samples/azure-search-dotnet-samples/tree/master/search-website-functions-v4) includes the following:
 
 |App|Purpose|GitHub<br>Repository<br>Location|
 |--|--|--|
-|Client|React app (presentation layer) to display books, with search. It calls the Azure Function app. |[/search-website/src](https://github.com/Azure-Samples/azure-search-dotnet-samples/tree/master/search-website/src)|
-|Server|Azure .NET Function app (business layer) - calls the Azure Cognitive Search API using .NET SDK |[/search-website/api](https://github.com/Azure-Samples/azure-search-dotnet-samples/tree/master/search-website/api)|
-|Bulk insert|.NET file to create the index and add documents to it.|[/search-website/bulk-insert](https://github.com/Azure-Samples/azure-search-dotnet-samples/tree/master/search-website/bulk-insert)|
+|Client|React app (presentation layer) to display books, with search. It calls the Azure Function app. |[/search-website-functions-v4/](https://github.com/Azure-Samples/azure-search-dotnet-samples/tree/master/search-website-functions-v4/client)|
+|Server|Azure .NET Function app (business layer) - calls the Azure Cognitive Search API using .NET SDK |[/search-website-functions-v4/api](https://github.com/Azure-Samples/azure-search-dotnet-samples/tree/master/search-website-functions-v4/api)|
+|Bulk insert|.NET file to create the index and add documents to it.|[/search-website-functions-v4/bulk-insert](https://github.com/Azure-Samples/azure-search-dotnet-samples/tree/master/search-website-functions-v4/bulk-insert)|
 
 ## Set up your development environment
 
 Install the following for your local development environment. 
 
-- [.NET 5](https://dotnet.microsoft.com/download/dotnet/5.0)  
+- [.NET 6](https://dotnet.microsoft.com/download/dotnet/6.0)  
 - [Git](https://git-scm.com/downloads)
 - [Visual Studio Code](https://code.visualstudio.com/) and the following extensions
-    - [Azure Resources](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azureresourcegroups)
     - [Azure Cognitive Search 0.2.0+](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azurecognitivesearch)
     - [Azure Static Web App](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azurestaticwebapps) 
 - Optional:
@@ -63,27 +53,11 @@ Forking the sample repository is critical to be able to deploy the Static Web Ap
 
     Complete the fork process in your web browser with your GitHub account. This tutorial uses your fork as part of the deployment to an Azure Static Web App. 
 
-1. At a bash terminal, download the sample application to your local computer. 
-
-    Replace `YOUR-GITHUB-ALIAS` with your GitHub alias. 
-
-    ```bash
-    git clone https://github.com/YOUR-GITHUB-ALIAS/azure-search-dotnet-samples
-    ```
-
-1. In Visual Studio Code, open your local folder of the cloned repository. The remaining tasks are accomplished from Visual Studio Code, unless specified.
+[!INCLUDE [tutorial-fork-and-clone](includes/tutorial-add-search-website-fork-and-clone.md)]
 
 ## Create a resource group for your Azure resources
 
-1. In Visual Studio Code, open the [Activity bar](https://code.visualstudio.com/docs/getstarted/userinterface), and select the Azure icon. 
-1. In Resources, select Add (**+**), and then select **Create Resource Group**.
-
-    :::image type="content" source="./media/tutorial-javascript-overview/visual-studio-code-create-resource-group.png" alt-text="In Resources, select Add (**+**), and then select **Create Resource Group**.":::
-1. Enter a resource group name, such as `cognitive-search-website-tutorial`. 
-1. Select a location close to you.
-1. When you create the Cognitive Search and Static Web App resources, later in the tutorial, use this resource group. 
-
-    Creating a resource group gives you a logical unit to manage the resources, including deleting them when you are finished using them.
+[!INCLUDE [tutorial-create-resource-group](includes/tutorial-add-search-website-create-resource-group.md)]
 
 ## Next steps
 
diff --git a/articles/search/tutorial-javascript-create-load-index.md b/articles/search/tutorial-javascript-create-load-index.md
@@ -83,30 +83,15 @@ The script uses the Azure SDK for Cognitive Search:
 
 ## Review the new Search Index
 
-Once the upload completes, the Search Index is ready to use. Review your new Index.
-
-1. In Visual Studio Code, open the Azure Cognitive Search extension and select your Search resource.  
-
-    :::image type="content" source="media/tutorial-javascript-create-load-index/visual-studio-code-search-extension-view-resource.png" alt-text="In Visual Studio Code, open the Azure Cognitive Search extension and open your Search resource.":::
-
-1. Expand Indexes, then Documents, then `good-books`, then select a doc to see all the document-specific data.
- 
-    :::image type="content" source="media/tutorial-javascript-create-load-index/visual-studio-code-search-extension-view-docs.png" lightbox="media/tutorial-javascript-create-load-index/visual-studio-code-search-extension-view-docs.png" alt-text="Expand Indexes, then `good-books`, then select a doc.":::
+[!INCLUDE [tutorial-load-index-review-index](includes/tutorial-add-search-website-load-index-review.md)]
 
 ## Rollback bulk import file changes
 
-Use the following git command in the VS Code integrated terminal at the `bulk-insert` directory, to roll back the changes. They aren't needed to continue the tutorial and you shouldn't save or push these secrets to your repo. 
-
-```git
-git checkout .
-```
+[!INCLUDE [tutorial-load-index-rollback](includes/tutorial-add-search-website-load-index-rollback-changes.md)]
 
 ## Copy your Search resource name
 
-Note your **Search resource name**. You'll need this to connect the Azure Function app to your Search resource. 
-
-> [!CAUTION]
-> While you may be tempted to use your Search admin key in the Azure Function, that isn't following the principle of least privilege. The Azure Function will use the query key to conform to least privilege. 
+[!INCLUDE [tutorial-load-index-copy](includes/tutorial-add-search-website-load-index-copy-resource-name.md)]
 
 ## Next steps
 
