Skip to content

Commit

Permalink
docs: add healthz documentation (#48)
Browse files Browse the repository at this point in the history
This also fixes the RSS feed dates and includes all pages in the root RSS feed.
  • Loading branch information
morremeyer authored Oct 23, 2023
1 parent 0b36681 commit d3f3390
Show file tree
Hide file tree
Showing 5 changed files with 84 additions and 0 deletions.
1 change: 1 addition & 0 deletions content/de/search.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
title: Suchergebnisse
layout: search
noRss: true
---
16 changes: 16 additions & 0 deletions content/en/docs/Reference/api/healthz.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: "Healthchecks"
description: >
This document describes the /healthz endpoint
date:
---

The backend exposes a healthcheck endpoint at `/healthz` in version `v3.3.0` and newer.

It returns

- HTTP 204 for success
- HTTP 500 with an error message when there is an error

Use this endpoint for health checks run by e.g. your monitoring, the Kubernetes liveness and readiness probes or
the docker compose health checks.
1 change: 1 addition & 0 deletions content/en/search.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
title: Search Results
layout: search
noRss: true
---
5 changes: 5 additions & 0 deletions hugo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -83,3 +83,8 @@ module:
disable: false
disableKinds:
- taxonomy

frontmatter:
date:
# Set the date to the git file date
- :git
61 changes: 61 additions & 0 deletions layouts/index.rss.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
{{- /* Deprecate site.Author.email in favor of site.Params.author.email */}}
{{- $authorEmail := "" }}
{{- with site.Params.author.email }}
{{- $authorEmail = . }}
{{- else }}
{{- with site.Author.email }}
{{- $authorEmail = . }}
{{- warnf "The author key in site configuration is deprecated. Use params.author.email instead." }}
{{- end }}
{{- end }}

{{- /* Deprecate site.Author.name in favor of site.Params.author.name */}}
{{- $authorName := "" }}
{{- with site.Params.author.name }}
{{- $authorName = . }}
{{- else }}
{{- with site.Author.name }}
{{- $authorName = . }}
{{- warnf "The author key in site configuration is deprecated. Use params.author.name instead." }}
{{- end }}
{{- end }}

{{- $pctx := . }}
{{- if .IsHome }}{{ $pctx = .Site }}{{ end }}
{{- $pages := slice }}
{{- if or $.IsHome $.IsSection }}
{{- $pages = $pctx.RegularPages }}
{{- else }}
{{- $pages = $pctx.Pages }}
{{- end }}
{{- $limit := .Site.Config.Services.RSS.Limit }}
{{- if ge $limit 1 }}
{{- $pages = $pages | first $limit }}
{{- end }}
{{- printf "<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\"?>" | safeHTML }}
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
<channel>
<title>{{ if eq .Title .Site.Title }}{{ .Site.Title }}{{ else }}{{ with .Title }}{{ . }} on {{ end }}{{ .Site.Title }}{{ end }}</title>
<link>{{ .Permalink }}</link>
<description>Recent content {{ if ne .Title .Site.Title }}{{ with .Title }}in {{ . }} {{ end }}{{ end }}on {{ .Site.Title }}</description>
<generator>Hugo -- gohugo.io</generator>
<language>{{ site.Language.LanguageCode }}</language>{{ with $authorEmail }}
<managingEditor>{{.}}{{ with $authorName }} ({{ . }}){{ end }}</managingEditor>{{ end }}{{ with $authorEmail }}
<webMaster>{{ . }}{{ with $authorName }} ({{ . }}){{ end }}</webMaster>{{ end }}{{ with .Site.Copyright }}
<copyright>{{ . }}</copyright>{{ end }}{{ if not .Date.IsZero }}
<lastBuildDate>{{ .Date.Format "Mon, 02 Jan 2006 15:04:05 -0700" | safeHTML }}</lastBuildDate>{{ end }}
{{- with .OutputFormats.Get "RSS" }}
{{ printf "<atom:link href=%q rel=\"self\" type=%q />" .Permalink .MediaType | safeHTML }}
{{- end }}
{{- range where .Site.Pages "Params.noRss" "==" nil }}
<item>
<title>{{ .Title }}</title>
<link>{{ .Permalink }}</link>
<pubDate>{{ .Date.Format "Mon, 02 Jan 2006 15:04:05 -0700" | safeHTML }}</pubDate>
{{- with $authorEmail }}<author>{{ . }}{{ with $authorName }} ({{ . }}){{ end }}</author>{{ end }}
<guid>{{ .Permalink }}</guid>
<description>{{ .Summary | html }}</description>
</item>
{{- end }}
</channel>
</rss>

0 comments on commit d3f3390

Please sign in to comment.