Skip to content

huluvu21/kentico-cloud-docs-dispatcher

 
 
master develop
Build Status codebeat badge Build Status codebeat badge

Kentico Cloud Documentation - Dispatcher

Backend function for Kentico Cloud documentation portal, which utilizes Kentico Cloud as a source of its content.

The function responds to webhooks from Kentico Cloud and then notifies search service and API reference service about changes in content.

Overview

  1. This project is a JavaScript Azure Functions application.
  2. It publishes events to an Azure Event Grid topic, where any number of subscribers can listen.
  3. Most importantly, the service forwards the type of Kentico Cloud operation along with codenames of the affected content items, so the subscribers can then act accordingly.

Setup

Prerequisites

  1. Node (+yarn) installed
  2. Visual Studio Code installed
  3. Subscriptions on MS Azure and Kentico Cloud

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

  • EventGrid.DocsChanged.Endpoint - Event Grid endpoint
  • EventGrid.DocsChanged.Key - Event Grid topic authentication key

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.

Licence

All the source codes are published under MIT licence.

About

Kentico Cloud Documentation - Dispatcher

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 76.8%
  • Shell 23.2%