Skip to content

Files

Failed to load latest commit information.

Latest commit

 Cannot retrieve latest commit at this time.

History

History
 
 

typesense

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
codefresh.json
codefresh.json
 
 

README.md

Search with Typesense

This folder holds configuration for the search engine used in the documentation.

Search is powered by the Typesense cloud

Requirements

There are 3 components needed for the search

  • A typesense cluster. This is hosted in the Typesense cloud (codefresh-io account)
  • A scrapper. This runs by Codefresh everytime we update the docs. It parses all documentation pages and creates an index in the Typesense cluster.
  • The search Filed. This is using the docsearch API to query the cluster for search results.

Configuration

The scrapper needs the file [config.json] and also an "Admin API key" to access the Typesense cluster. Currently the same Codefresh pipeline that deploys the documentation, also runs the scrapper and uploads the results at the Typesense cluster.

The search field needs just a "Search API" key to query the cluster.

To get/rotate the API keys you need to login with your Github account in the typesense cloud.