Skip to content

Commit 9e3243c

Browse files
committed
fixed acrolinx bugs
1 parent f826019 commit 9e3243c

5 files changed

+14
-10
lines changed

articles/search/includes/tutorial-add-search-website-create-app.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The static web app pulls the information and files for deployment from GitHub us
3737
|Select a SKU| Select the free SKU for this tutorial.|
3838
|Select a location for new resources.|For Node.js: Select `West US 2` during the Azure Function programming model (PM) v4 preview. For C# and Python, select a region near you.|
3939
|Choose build preset to configure default project structure.|Select **Custom**|
40-
|Select the location of your application code|`search-website-functions-v4/client-v4`<br><br>This is the path, from the root of the repository, to your static web app. |
40+
|Select the location of your client application code|`search-website-functions-v4/client-v4`<br><br>This is the path, from the root of the repository, to your static web app. |
4141
|Select the location of your Azure Functions code|`search-website-functions-v4/api-v4`<br><br>This is the path, from the root of the repository, to your static web app. If there are no other functions in the repository, you won't be prompted for the function code location. Currently, you'll need to perform extra steps to ensure the function code location is correct. These steps are performed after the resource is created and are documented in this article. |
4242
|Enter the path of your build output...|`build`<br><br>This is the path, from your static web app, to your generated files.|
4343

@@ -53,7 +53,7 @@ The static web app pulls the information and files for deployment from GitHub us
5353

5454
:::image type="content" source="../media/tutorial-javascript-static-web-app/visual-studio-code-azure-activity-log.png" alt-text="Screenshot of the Activity Log in Visual Studio Code." border="true":::
5555

56-
1. Currently, the YML file is created with erroneous path syntax for the Azure function code. Use this workaround to correct the syntax. You can perfrom this step as soon as the YML file is created. A new workflow will launch as soon as you push the updates:
56+
1. Currently, the YML file is created with erroneous path syntax for the Azure function code. Use this workaround to correct the syntax. You can perform this step as soon as the YML file is created. A new workflow will launch as soon as you push the updates:
5757

5858
1. In Visual Studio Code explorer, open the `./.github/workflows/` directory.
5959

@@ -137,7 +137,7 @@ The Azure Function app won't return search data until the search secrets are in
137137

138138
1. Select **Save** to save the settings.
139139

140-
:::image type="content" source="../media/tutorial-javascript-static-web-app/save-new-application-setting-to-static-web-app-in-portal.png" alt-text="Screenshot of browser showing Azure portal with the button to save the settings for your app..":::
140+
:::image type="content" source="../media/tutorial-javascript-static-web-app/save-new-application-setting-to-static-web-app-in-portal.png" alt-text="Screenshot of browser showing Azure portal with the button to save the settings for your app.":::
141141

142142
1. Return to Visual Studio Code.
143143

articles/search/includes/tutorial-add-search-website-troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,4 @@ If the web app didn't deploy or work, use the following list to determine and fi
2020

2121
You should be able to interact with the client app, searching for books and filtering. If the form doesn't return any values, open the browser's developer tools, and determine if the HTTP calls to the API were successful. If the calls weren't successful, the most likely reason if the static web app configurations for the API endpoint name and Search query key are incorrect.
2222

23-
If the path to the Azure function code (`api_location`) isn't correct in the YML file, the application loads but won't call any of the functions that provide integration with Cognitive Search. Revisit the workaround in the deployment section for help in correcting the path.
23+
If the path to the Azure function code (`api_location`) isn't correct in the YML file, the application loads but won't call any of the functions that provide integration with Cognitive Search. Revisit the workaround in the deployment section for help with correcting the path.

articles/search/includes/tutorial-add-search-website-what-sample-does.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,10 @@ This sample website provides access to a catalog of 10,000 books. A user can sea
99

1010
:::image type="content" source="../media/tutorial-javascript-overview/cognitive-search-enabled-book-website-2.png" alt-text="Screeshot of the sample app in a browser window.":::
1111

12-
The search experience includes:
12+
The search experience includes:
1313

1414
* Search – provides search functionality for the application.
1515
* Suggest – provides suggestions as the user is typing in the search bar.
16+
* Facets and filters - provides a faceted navigation structure that filters by author or language.
17+
* Paginated results - provides paging controls for scrolling through results.
1618
* Document Lookup – looks up a document by ID to retrieve all of its contents for the details page.

articles/search/tutorial-javascript-overview.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,11 @@ ms.devlang: javascript
1414

1515
# 1 - Overview of adding search to a website
1616

17-
In this Azure Cognitive Search tutorial, create a web app that searches through a catalog of books, and then deploy the website to an Azure Static Web Apps resource. This tutorial is for JavaScript developers who want to know more about creating a client app that includes user interactions like faceted navigation, typeahead, and pagination. It also demonstrates the `@azure/search-documents` library in the Azure SDK for JavaScript for calls to Azure Cognitive Search for indexing and query workflows.
17+
In this Azure Cognitive Search tutorial, create a web app that searches through a catalog of books, and then deploy the website to an Azure Static Web Apps resource.
1818

19-
The source code is available in the [azure-search-javascript-samples](https://github.com/Azure-Samples/azure-search-javascript-samples/tree/master/search-website-functions-v4) GitHub repository.
19+
This tutorial is for JavaScript developers who want to create a frontend client app that includes search interactions like faceted navigation, typeahead, and pagination. It also demonstrates the `@azure/search-documents` library in the Azure SDK for JavaScript for calls to Azure Cognitive Search for indexing and query workflows on the backend.
20+
21+
Source code is available in the [azure-search-javascript-samples](https://github.com/Azure-Samples/azure-search-javascript-samples/tree/master/search-website-functions-v4) GitHub repository.
2022

2123
## What does the sample do?
2224

@@ -38,7 +40,7 @@ Install the following software in your local development environment.
3840

3941
- [Node.js LTS](https://nodejs.org/en/download)
4042
- Select latest runtime and version from this [list of supported language versions](../azure-functions/functions-versions.md?pivots=programming-language-javascript&tabs=azure-cli%2clinux%2cin-process%2cv4#languages).
41-
- If you have a different version of Node.js installed on your local computer, consider using [Node Version Manager](https://github.com/nvm-sh/nvm) (nvm) or a Docker container.
43+
- If you have a different version of Node.js installed on your local computer, consider using [Node Version Manager](https://github.com/nvm-sh/nvm) (`nvm`) or a Docker container.
4244
- [Git](https://git-scm.com/downloads)
4345
- [Visual Studio Code](https://code.visualstudio.com/) and the following extensions
4446
- [Azure Static Web App](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azurestaticwebapps)

articles/search/tutorial-javascript-search-query-integration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,11 +73,11 @@ This function API is called in the React app at `\src\pages\Details\Detail.js` a
7373

7474
## Next steps
7575

76-
In this tutorial series, you learned how to create and load a search index in JavaScript, and you built a web app that provides a search experience that includes a search bar, faceted navigation and filters, suggestions, pagination, and lookup.
76+
In this tutorial series, you learned how to create and load a search index in JavaScript, and you built a web app that provides a search experience that includes a search bar, faceted navigation and filters, suggestions, pagination, and document look up.
7777

7878
As a next step, you can extend this sample in several directions:
7979

8080
* Add [autocomplete](search-add-autocomplete-suggestions.md) for more typeahead.
8181
* Add or modify [facets](search-faceted-navigation.md) and [filters](search-filters.md).
8282
* Change the authentication and authorization model, using [Azure Active Directory](search-security-rbac.md) instead of [key-based authentication](search-security-api-keys.md).
83-
* Change the [indexing methodology](search-what-is-data-import.md). Instead of pushing JSON to a search documents, preload a blob container with the good-books dataset and [set up a blob indexer](search-howto-indexing-azure-blob-storage.md) to ingest the data. Knowing how to work with indexers gives you more options for data ingestion and [content enrichment](cognitive-search-concept-intro.md) during indexing.
83+
* Change the [indexing methodology](search-what-is-data-import.md). Instead of pushing JSON to a search index, preload a blob container with the good-books dataset and [set up a blob indexer](search-howto-indexing-azure-blob-storage.md) to ingest the data. Knowing how to work with indexers gives you more options for data ingestion and [content enrichment](cognitive-search-concept-intro.md) during indexing.

0 commit comments

Comments
 (0)