Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
97 changes: 0 additions & 97 deletions .flox/env/manifest.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions .github/workflows/fern-docs-ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ on:
pull_request:
paths:
- 'docs/**'
- 'k8s/helm/values.yaml'
- '.github/workflows/fern-docs-ci.yaml'

permissions:
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ docs/fern/generated/
docs/fern/versions/[0-9]*.yml
docs/fern/versions/v[0-9]*.yml

# Generated from k8s/helm/values.yaml + README.md at docs build time (docs/fern/scripts/sync-helm-docs.mjs)
# Generated from k8s/helm/README.md + k8s/helm/values.yaml at docs build time (docs/fern/scripts/sync-helm-docs.mjs)
docs/helm/index.mdx

# nektos/act files commonly used
Expand Down
15 changes: 0 additions & 15 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -68,21 +68,6 @@ repos:
docs/set-up/config-reference\.mdx
)$

- repo: https://github.com/norwoodj/helm-docs
# The container itself is 'latest' no matter what here
rev: v1.14.2
hooks:
- id: helm-docs
files: |
(?x)^(
k8s/helm/values\.yaml|
k8s/helm/Chart\.yaml|
k8s/helm/helm-docs-template/nemo-helm-readme\.md\.gotmpl
)$
args:
- --chart-search-root=k8s/helm/
- --template-files=k8s/helm/helm-docs-template/nemo-helm-readme.md.gotmpl

- repo: local
hooks:
- id: uv-lock
Expand Down
10 changes: 6 additions & 4 deletions docs/fern/scripts/sync-helm-docs.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
/**
* Generate docs/helm/index.mdx from k8s/helm/README.md and k8s/helm/values.yaml.
*
* Intro prose comes from README.md (generated by helm-docs); the Values section
* Intro prose comes from the checked-in Helm chart README; the Values section
* embeds the raw values.yaml as a syntax-highlighted code block.
*
* Runs as part of `npm run prepare` before every Fern build. Do not edit
Expand Down Expand Up @@ -45,7 +45,9 @@ function stripLeadingSpdxComments(markdown) {

while (
lines.length &&
(lines[0].startsWith("<!-- SPDX-") || lines[0].trim() === "")
(lines[0].startsWith("<!-- SPDX-") ||
lines[0].startsWith("{/* SPDX-") ||
lines[0].trim() === "")
) {
lines.shift();
}
Expand Down Expand Up @@ -75,11 +77,11 @@ function extractIntro(readme) {
return out.join("\n");
}

export function buildHelmReferenceMdx(readme, valuesYaml) {
export function buildHelmReferenceMdx(introMarkdown, valuesYaml) {
return (
FRONTMATTER +
"\n" +
extractIntro(readme) +
extractIntro(introMarkdown) +
"\n\n" +
"## Values\n\n" +
"The following is the complete `values.yaml` for the NeMo Platform Helm Chart.\n" +
Expand Down
Loading
Loading