From 5d0e8f0b7a00884a2b07eb41abb97e67160d57ae Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rn=20Friedrich=20Dreyer?= Date: Fri, 24 Mar 2023 11:39:41 +0100 Subject: [PATCH] fix notificaation readme, more precise naming MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Jörn Friedrich Dreyer --- docs/helpers/main.go | 2 +- docs/helpers/markdowncreation.go | 4 ++-- services/notifications/README.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/helpers/main.go b/docs/helpers/main.go index c8d57311b..2f150567f 100644 --- a/docs/helpers/main.go +++ b/docs/helpers/main.go @@ -4,5 +4,5 @@ func main() { RenderTemplates() GetRogueEnvs() RenderGlobalVarsTemplate() - GenerateMarkdowns() + GenerateServiceIndexMarkdowns() } diff --git a/docs/helpers/markdowncreation.go b/docs/helpers/markdowncreation.go index 10fa020e8..33dbf5ad0 100644 --- a/docs/helpers/markdowncreation.go +++ b/docs/helpers/markdowncreation.go @@ -18,8 +18,8 @@ var _configMarkdown = `{{< include file="services/_includes/%s-config-example.ya {{< include file="services/_includes/%s_configvars.md" >}} ` -// GenerateMarkdowns generates the _index.md files for the dev docu -func GenerateMarkdowns() { +// GenerateServiceIndexMarkdowns generates the _index.md files for the dev docu +func GenerateServiceIndexMarkdowns() { paths, err := filepath.Glob("../../services/*/README.md") if err != nil { log.Fatal(err) diff --git a/services/notifications/README.md b/services/notifications/README.md index 439247e16..507d7afab 100644 --- a/services/notifications/README.md +++ b/services/notifications/README.md @@ -1,4 +1,4 @@ -#### Notification service +# Notification service The notification service is responsible for sending emails to users informing them about events that happened. To do this it hooks into the event system and listens for certain events that the users need to be informed about.