Skip to content

About

Documentation for the Open Monitoring Distribution and related projects at https://omd.consol.de

Resources

Stars

2 stars

Watchers

5 watching

Forks

Repository files navigation

omd-consol-de

Website https://omd.consol.de

docker build -t consol/omd-consol-de .
docker run --rm -p 1313:1313 -v `pwd`:/src consol/omd-consol-de server
podman run --security-opt label=disable --rm -p 1313:1313 -v "$(pwd):/src" consol/omd-consol-de server --poll 700ms

Build compatibility

The container image installs Dart Sass (sass-embedded@1.102.0); npm-based builds get the same compiler from package.json. Both build paths use Hugo 0.169.0. Kubernetes installs the compiler in an init container; see deployment instructions.

Docsy is pinned to 0.18.1 through github.com/docsy/docsy/theme. Its upstream Sass pipeline and base templates are used directly. The remaining overrides provide the site's custom navigation, archive, search, privacy policy, and design.

Docsy's Bootstrap and Font Awesome dependencies are pinned in the generated packages/hugoautogen workspace and package-lock.json. After changing Docsy or package.json, run hugo mod npm pack and npm install, then commit the workspace files and lockfile. Container startup installs the asset workspace when its pinned versions are missing; the Kubernetes builder does the same before publishing a revision. Native npm builds use npm ci normally.

Local fonts and browser resources

assets/scss/_variables_project.scss disables Docsy's Google Fonts loading with $td-enable-google-fonts: false and loads Open Sans from static/assets/open-sans/. Keep these settings when updating the theme.

The custom layouts/_partials/head.html loads the local Lunr library and sets a Content Security Policy that restricts browser resources to this site. jQuery is no longer loaded. Badge images are fetched during the Hugo build and published locally by layouts/_markup/render-image.html.

Blog archive

Blog posts published before params.blog_archive_before in config.toml (currently 2018-01-01) appear in /blog/archive/. Their files, article URLs, and page resources stay in place. The cutoff uses the publication date, not last modification time.

Override the date rule in an individual post's YAML front matter:

archived: false # Keep an older, still-current article in the main news/search.
archived: true # Archive a newer article that is no longer current.

Use actual YAML booleans, not quoted strings. The same archive rule controls news listings, sidebar entries, feeds, article previous/next links, tag-page groups, search indexes, and the blog content in the LLM exports. The open archived article remains visible in its sidebar. Tag pages keep historical articles in a collapsed group.

Normal search uses offline-search-index.json; the archive search uses archive-search-index.json, fetched only when a query is entered in the archive. exclude_search: true excludes a post from both indexes without changing its archive status. Archived articles remain published in the sitemap and accessible to external search engines.

The 2017 and 2019 workshop material lives under content/en/blog/insights/ and is published at /blog/insights/monitoring-workshop-2017/ and /blog/insights/monitoring-workshop-2019/. Hugo aliases redirect the former /wiki/workshop/.../ page addresses to their corresponding Insights pages. legacy_resource_path republishes the bundled PDFs and images at their old addresses so existing download links remain valid. Each workshop is a branch bundle with an _index.md article marked blog_post: true; supporting pages and assets live in the same folder. The supporting pages stay out of listings and search through the bundle cascade. Both workshop articles follow the archive cutoff. The former /wiki/ and /wiki/workshop/ indexes redirect to Insights.

About

Documentation for the Open Monitoring Distribution and related projects at https://omd.consol.de

Resources

Stars

2 stars

Watchers

5 watching

Forks

Releases

Packages

Used by

Contributors

Languages