master	develop

Kontent.ai Documentation - API Reference Search

Backend service for Kontent.ai Learn that uses Kontent.ai to fetch content. The service is responsible for indexing API reference.

The service responds to events triggered by the blob storage, after the Reference Preprocessor creates a blob with the preprocessed data. The API reference service processes the data and stores the content ready to index on Algolia in an Azure Blob Storage.

Overview

1. This project is a TypeScript Azure Functions application.
2. It is subscribed to an Azure Event Grid topic and listens for events. Each event contains information about the content that was changed.
3. After receiving an event, it fetches the content from the Blob storage.
4. The fetched content is then split into smaller Algolia-compatible records.
5. Finally the records are stored in an Azure Blob Storage, where the following Indexing Sync service can access it and update the index on Algolia accordingly.

Setup

Prerequisites

1. Node (+yarn) installed
2. Visual Studio Code installed
3. Subscriptions on MS Azure, Kontent.ai and Algolia

Instructions

1. Open Visual Studio Code and install the prerequisites according to the following steps.
2. Log in to Azure using the Azure Functions extension tab.
3. Clone the project repository and open it in Visual Studio Code.
4. Run yarn install in the terminal.
5. Set the required keys.
6. Deploy to Azure using Azure Functions extension tab, or run locally by pressing Ctrl + F5 in Visual Studio Code.

Required Keys

• Azure.StorageKey - Azure Storage key
• Azure.StorageAccountName - Azure Storage account name
• Azure.ContainerName - Azure Storage container name
• Azure.ClearIndexUrl - URL of the kcd-clear-index Azure function

Testing

• Run yarn run test in the terminal.

How To Contribute

Feel free to open a new issue where you describe your proposed changes, or even create a new pull request from your branch with proposed changes.

License

All the source codes are published under MIT license.