This repository provides following workflows:
- Release: builds and deploys website to https://hub.studyathome.technikum-wien.at/
- Prerelease: builds and deploys website to https://hub.studyathome.technikum-wien.at/next/
- Algolia: deletes previous, creates and uploads new index to Algolia
NOTE: Workflow Release
runs Algolia
after building the website automatically.
Don't run workflow Algolia
after running Prerelease
since it won't have any effect.
When running workflow Algolia
manually, enable deletion of the previous index to avoid execeeding the allowed amount of index records.
To update the search index of algolia run following command:
docker run -it --env-file=.env -e "CONFIG=$(cat ./docs/.vuepress/config/algolia.json | jq -r tostring)" algolia/docsearch-scraper
To run this command, you need following tools installed: docker
, jq
.
Additionally, create a file .env
and specify following variables:
APPLICATION_ID=<APP_ID>
API_KEY=<API_KEY>