Sync all docs using new mech#1235
Merged
Merged
Conversation
Signed-off-by: Fiachra Corcoran <fiachra.corcoran@est.tech>
efiacor
requested review from
kispaljr,
liamfallon and
mozesl-nokia
as code owners
✅ Deploy Preview for krm-function-catalog ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
Syncs the Hugo site documentation with the function README/metadata sources, including normalizing front matter and updating links/refs across generated docs and examples.
Changes:
- Updates the docs generator to emit Hugo front matter correctly and replace
:latestimage tags with the latest released minor tag (e.g.v0.2). - Removes deprecated/unused metadata tag values from the metadata JSON schema and cleans up affected function metadata.
- Regenerates/updates multiple function docs and example READMEs (links, refs, descriptions, and new pages like
set-image/v0.2andrender-helm-chart/v0.3).
Reviewed changes
Copilot reviewed 45 out of 45 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/generate_docs/metadata-schema.json | Drops unused tag enum values to align metadata validation with current tag set. |
| scripts/generate_docs/main_test.go | Adds unit tests for replaceVersionTags. |
| scripts/generate_docs/generate_docs.go | Fixes Hugo front matter placement and replaces :latest with latest minor version in generated docs. |
| functions/go/starlark/README.md | Updates external links (Starlib + kpt.dev anchors). |
| functions/go/set-labels/README.md | Pins kustomize source links to a specific tag. |
| functions/go/set-image/README.md | Pins kustomize source links to a specific tag. |
| functions/go/set-enforcement-action/metadata.yaml | Removes deprecated Config Sync tag. |
| functions/go/set-annotations/README.md | Pins kustomize source links to a specific tag. |
| functions/go/search-replace/README.md | Updates a Kubernetes design-proposal reference URL. |
| functions/go/remove-local-config-resources/metadata.yaml | Removes deprecated GCP / Config Sync tags. |
| functions/go/list-setters/README.md | Uses fully-qualified image reference and updates doc cross-links to Hugo relref. |
| functions/go/generate-kpt-pkg-docs/metadata.yaml | Removes deprecated blueprints tag. |
| functions/go/ensure-name-substring/README.md | Pins kustomize source links to a specific tag. |
| functions/go/create-setters/README.md | Updates setter-definition link to Hugo relref. |
| functions/go/apply-setters/README.md | Updates cross-doc link to use Hugo relref. |
| examples/generate-kpt-pkg-docs-simple/README.md | Replaces catalog link with GitHub source link. |
| examples/gatekeeper-invalid-configmap/README.md | Switches function link to Hugo relref. |
| examples/gatekeeper-imperative/README.md | Switches function link to Hugo relref. |
| examples/gatekeeper-disallow-root-user/README.md | Switches function link to Hugo relref. |
| examples/ensure-name-substring-suffix/README.md | Switches function link to Hugo relref. |
| examples/ensure-name-substring-prefix/README.md | Switches function link to Hugo relref. |
| examples/ensure-name-substring-imperative/README.md | Switches function link to Hugo relref. |
| examples/ensure-name-substring-depends-on/README.md | Switches function link to Hugo relref. |
| examples/ensure-name-substring-advanced/README.md | Switches function link to Hugo relref. |
| examples/apply-setters-simple/README.md | Updates cross-doc link to use Hugo relref. |
| documentation/content/en/upsert-resource/v0.2/_index.md | Regenerated content: updated description, adds generation marker, expands usage/example. |
| documentation/content/en/starlark/v0.5/_index.md | Regenerated content: marker + minor formatting tweaks. |
| documentation/content/en/set-namespace/v0.4/_index.md | Regenerated content: marker + updated description. |
| documentation/content/en/set-labels/v0.2/_index.md | Regenerated content: marker + pinned kustomize link. |
| documentation/content/en/set-labels/v0.1/_index.md | Pins kustomize source link. |
| documentation/content/en/set-image/v0.2/_index.md | Adds generated doc page for set-image v0.2. |
| documentation/content/en/set-image/v0.1/_index.md | Pins kustomize source link. |
| documentation/content/en/set-enforcement-action/v0.1/_index.md | Regenerated content: removes config-sync tag, adds marker, description tweak. |
| documentation/content/en/set-annotations/v0.1/_index.md | Regenerated content: marker, heading normalization, pinned kustomize link. |
| documentation/content/en/search-replace/v0.2/_index.md | Regenerated content: marker + punctuation tweak. |
| documentation/content/en/render-helm-chart/v0.3/_index.md | Adds generated doc page for render-helm-chart v0.3. |
| documentation/content/en/remove-local-config-resources/v0.1/_index.md | Regenerated content: removes config-sync tag, adds marker, description tweak. |
| documentation/content/en/list-setters/v0.1/_index.md | Regenerated content: marker + usage snippet update. |
| documentation/content/en/kubeconform/v0.1/_index.md | Regenerated content: marker + updated description. |
| documentation/content/en/gatekeeper/v0.2/_index.md | Regenerated content: marker + punctuation tweak. |
| documentation/content/en/ensure-name-substring/v0.2/_index.md | Regenerated content: marker + issue link fix + pinned kustomize links. |
| documentation/content/en/ensure-name-substring/v0.1/_index.md | Issue link fix + pinned kustomize links. |
| documentation/content/en/create-setters/v0.1/_index.md | Regenerated content: marker + formatting tweaks. |
| documentation/content/en/apply-setters/v0.2/_index.md | Regenerated content: marker + CLI example update + cross-doc relref. |
| documentation/content/en/apply-replacements/v0.1/_index.md | Regenerated content: marker + cleans up link formatting. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Collaborator
|
There's a few copilot comments on here. |
Signed-off-by: Fiachra Corcoran <fiachra.corcoran@est.tech>
CsatariGergely
approved these changes
Apr 21, 2026
liamfallon
approved these changes
Apr 21, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Sync the hugo site docs with the existing fn READMEs