Skip to content

Commit

Permalink
Merge pull request #34 from Kentico/feature/documentationLinks
Browse files Browse the repository at this point in the history
 Documentation added images for better quick start
  • Loading branch information
ondrejhenek authored Feb 13, 2024
2 parents f1b8cd7 + ab961c9 commit 31d109d
Show file tree
Hide file tree
Showing 7 changed files with 6 additions and 10 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ dotnet add package Kentico.Xperience.Algolia
}
```

2. Define a custom `DefaultAlgoliaIndexingStrategy` implementation to customize how content pages/content items are processed for the index.
2. Define a custom `DefaultAlgoliaIndexingStrategy` implementation to customize how content pages/content items are processed for the index. See [`Custom-index-strategy.md`](docs/Custom-index-strategy.md)
3. Add this library to the application services, registering your custom `DefaultAlgoliaIndexingStrategy` and Algolia services

```csharp
Expand All @@ -48,8 +48,10 @@ dotnet add package Kentico.Xperience.Algolia
```

4. Create an index in Xperience's Administration within the Search application added by this library.
5. Rebuild the index in Xperience's Administration within the Search application added by this library.
6. Display the results on your site with a Razor View 👍.
![Administration search edit form](/images/xperience-administration-search-index-edit-form.jpg)
1. Rebuild the index in Xperience's Administration within the Search application added by this library.
![Administration search edit form](/images/xperience-administration-search-index-list.jpg)
1. Display the results on your site with a Razor View 👍.

## Full Instructions

Expand Down
2 changes: 1 addition & 1 deletion docs/Managing-Indexes.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Create a new index or select and index to edit by clicking the index row or the

Fill out the search index form, populating the fields with your custom values.

![Administration search index list](/images/xperience-administration-search-index-edit-form.jpg)
![Administration search edit form](/images/xperience-administration-search-index-edit-form.jpg)

- Rebuild Hook - for validating a request rebuild of the search index from an external source (ex: API request)
- Indexed Languages - the index will only include content in the selected languages
Expand Down
6 changes: 0 additions & 6 deletions examples/DancingGoat/appsettings.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,6 @@
},
"CMSHashStringSalt": "sal",
"WebCrawlerBaseUrl": "http://localhost:63328",
"CMSAdminClientModuleSettings": {
"kentico-xperience-integrations-algolia": {
"Mode": "Proxy",
"Port": 3009
}
},
"CMSAlgoliaSearch": {
"ApplicationId": "",
"ApiKey": "",
Expand Down
Binary file modified images/xperience-administration-dashboard.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/xperience-administration-search-index-edit-form.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/xperience-administration-search-index-list.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 31d109d

Please sign in to comment.