diff --git a/docs/helpers/main.go b/docs/helpers/main.go index c8d57311b6..2f150567fb 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 10fa020e80..33dbf5ad00 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 439247e162..507d7afab3 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.