docs(platform): add missing database field to platform config referen…#1945
docs(platform): add missing database field to platform config referen…#1945
Conversation
…ce (DOC-1313) Bump github.com/loft-sh/api/v4 from v4.6.0 to v4.8.1 and regenerate platform API reference partials. This adds the missing `database` (DatabaseKine) config field to status_reference.mdx and reference.mdx, removes the now-deleted `external` config partials, and picks up other API additions (metal3 node provider, namespaceTemplate project field, DirectClusterEndpointToken rename). Also fixes generator hardcoded title "Move VCluster" → "Move vCluster". Closes DOC-1313 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
✅ Deploy Preview for vcluster-docs-site ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Document that github.com/loft-sh/api/v4 must be bumped to match the new platform version before running the partials generator, so new config fields are not silently omitted from the reference docs. Also corrects the description of what the generator reads (Go types primary, vCluster schema secondary). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
… feature table - Add .markdownlintignore to exclude vendor/ and node_modules/ from markdownlint, preventing noisy review comments on third-party files - Scope misspell to docs directories only (vendor already excluded by vale) - Re-sync FeatureTable in nodeprovider.mdx after generator regeneration Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
CI failures — cause and fixActual build failure:
|
Versioned vCluster docs (0.28-0.30) import from @site/platform/api/_partials/resources/config/external.mdx and related sub-partials. The generator deleted these when it was re-run against api/v4 v4.8.1, which no longer has the External config field. Restoring them from the pre-bump state so the cross-plugin imports in frozen versioned docs continue to resolve. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Build fix: restored deleted
|
The generator does os.RemoveAll on the entire partials directory before regenerating. When an API field is removed, its partial files disappear and break frozen versioned docs that still import them via @site/platform/... Add removeAllExceptPreserved(): reads platform/api/_partials/resources/ .generator-preserve, backs up listed paths to a temp dir, runs RemoveAll, then restores them. The manifest file itself is always restored too. Seed the manifest with the external config partials (removed in api/v4 v4.8.1) that versioned vCluster docs 0.28-0.30 still import. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Fix: generator now preserves legacy partials across runsImplemented Option B from the previous comment. What changed
For future casesIf a future API bump causes the generator to delete partials that frozen versioned docs still import, the fix is a one-line addition to ScopeThe restored |
…se skill Add guidance for identifying and handling partials deleted by the generator that frozen versioned docs still import: - Part 1: new step 5 with audit commands to check git-deleted files against versioned doc imports after running the generator - API Partials Generation: document the .generator-preserve mechanism, its backup/restore behavior, and when to add entries - Troubleshooting: add recipe for the "Cannot find module @site/platform/ api/_partials/..." build failure with step-by-step resolution - release-checklist.md: matching checklist item with audit commands Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Release skill updated with
|
Piotr1215
left a comment
There was a problem hiding this comment.
Looks good overall. One question about removed hand-written docs sections.
Content Description
Regenerates autogenerated docs for 4.8.1.
Adds missing database field to platform conf reference (DOC-1313).
Bump github.com/loft-sh/api/v4 from v4.6.0 to v4.8.1 and regenerate platform API reference partials. This adds the missing
database(DatabaseKine) config field to status_reference.mdx and reference.mdx, removes the now-deletedexternalconfig partials, and picks up other API additions (metal3 node provider, namespaceTemplate project field, DirectClusterEndpointToken rename).Also fixes generator hardcoded title "Move VCluster" → "Move vCluster".
Preview Link
https://deploy-preview-1945--vcluster-docs-site.netlify.app/docs/platform/next/configure/platform-configs/overview#database
(Showing that the missing
databasefield now exists.)Internal Reference
Closes DOC-1313
AI review: mention
@claudein a comment to request a review or changes. See CONTRIBUTING.md for available commands.@netlify /docs