From aeaa567ce0d6abbfb0bafbcdc661c79195fa06ed Mon Sep 17 00:00:00 2001 From: weru <fromweru@gmail.com> Date: Mon, 27 Feb 2023 15:06:57 +0000 Subject: [PATCH] update documentation for algolia search --- exampleSite/content/docs/compose/github-actions.md | 15 +++++++++------ 1 files changed, 9 insertions(+), 6 deletions(-) diff --git a/exampleSite/content/docs/compose/github-actions.md b/exampleSite/content/docs/compose/github-actions.md index f3cb074..76869f7 100644 --- a/exampleSite/content/docs/compose/github-actions.md +++ b/exampleSite/content/docs/compose/github-actions.md @@ -1,22 +1,25 @@ +++ description = "Use github actions with compose theme" -title = "Leverage Github actions to publish with compose theme" +title = "Leverage Github actions" weight = 11 +++ This theme ships with 2 github actions inside the exampleSite folder: 1. AWS CI - - This helps you to autodeploy your hugo website from github to an AWS s3 bucket. Set the secrets in the action accordingly and voila. - 2. Algolia CI - When [algolia search integration](https://github.com/onweru/compose/issues/98) is rolls out (soon), this action will automatically update your algolia search index. No extra npm manual setup will be needed. +## AWS CI + + This helps you to autodeploy your hugo website from github to an AWS s3 bucket. Set the secrets in the action accordingly and voila. + +## Algolia CI + + This action will automatically update your algolia search index. No extra npm manual setup will be needed. These actions are customizable to fire off under your specified set of circumstances. -By default, the actions will be off, so be sure to turn them on +By default, the actions will be off, so be sure to turn them on, and set the github actions secrets appropriately. ```shell name: Update Algolia Search Index -- Gitblit v1.10.0