Skip to content

Add a note about clustering #131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zrzka merged 3 commits into from
Mar 24, 2026
Merged

Add a note about clustering #131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b735ba9
Add a note
zrzka Mar 24, 2026
870805c
Changelog
zrzka Mar 24, 2026
a98559c
Oops
zrzka Mar 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions charts/document-engine/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Changelog

- [Changelog](#changelog)
- [8.1.2 (2026-03-24)](#812-2026-03-24)
- [Changed](#changed)
- [8.1.1 (2026-03-12)](#811-2026-03-12)
- [Fixed](#fixed)
- [8.1.0 (2026-02-28)](#810-2026-02-28)
Expand Down Expand Up @@ -219,6 +221,13 @@
- [2.0.0](#200)
- [Changed](#changed-62)

## 8.1.2 (2026-03-24)

### Changed

* `README.md.gotmpl`: added support for section-wide notes in generated values sections
* `README.md`: added a note in the `Clustering` section that it is an experimental feature

## 8.1.1 (2026-03-12)

### Fixed
Expand Down
2 changes: 1 addition & 1 deletion charts/document-engine/Chart.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ type: application
description: Document Engine is a backend software for processing documents and powering automation workflows.
home: https://www.nutrient.io/sdk/document-engine
icon: https://cdn.prod.website-files.com/65fdb7696055f07a05048833/66e58e33c3880ff24aa34027_nutrient-logo.png
version: 8.1.1
version: 8.1.2
appVersion: "1.14.0"

keywords:
Expand Down
5 changes: 4 additions & 1 deletion charts/document-engine/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Document Engine Helm chart

![Version: 8.1.1](https://img.shields.io/badge/Version-8.1.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.14.0](https://img.shields.io/badge/AppVersion-1.14.0-informational?style=flat-square)
![Version: 8.1.2](https://img.shields.io/badge/Version-8.1.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.14.0](https://img.shields.io/badge/AppVersion-1.14.0-informational?style=flat-square)

Document Engine is a backend software for processing documents and powering automation workflows.

Expand Down Expand Up @@ -552,6 +552,9 @@ Note:

### Clustering

> [!NOTE]
> Clustering is an experimental feature; use with caution!

| Key | Description | Default |
|-----|-------------|---------|
| [`clustering`](./values.yaml#L594) | Clustering settings | |
Expand Down
11 changes: 11 additions & 0 deletions charts/document-engine/README.md.gotmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,12 @@ Functions {

{{- define "chart.valuesTable" -}}
{{- if .Sections.Sections -}}
{{- $sectionNotes := dict
"Clustering" (trim `
> [!NOTE]
> Clustering is an experimental feature; use with caution!
`)
-}}
{{- $sectionNames := list -}}
{{- range .Sections.Sections -}}
{{- $sectionNames = append $sectionNames .SectionName -}}
Expand Down Expand Up @@ -89,6 +95,11 @@ Functions {

### {{ .SectionTitle }}

{{- with index $sectionNotes .SectionTitle }}

{{ . }}
{{- end }}

| Key | Description | Default |
|-----|-------------|---------|
{{- range .SectionItems }}
Expand Down
Loading