skills.rest
loft-sh
loft-shOFFICIAL
Explore all skills by this author →
Website𝕏@vclusterGitHub

config-partials-generator

Generate MDX config reference partials from the vCluster JSON schema.

11|57|Updated Mar 4, 2024
Search Tags:#automation#documentation#generate#mdx#vcluster#config-partials
One-click install
npx skills add https://github.com/loft-sh/vcluster-docs --skill config-partials-generator
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: config-partials-generator
Source: https://github.com/loft-sh/vcluster-docs/tree/main/.claude/skills/config-partials-generator
Command: npx skills add https://github.com/loft-sh/vcluster-docs --skill config-partials-generator

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generates MDX config reference partials from the vCluster JSON schema. The CI automation (sync-config-schema.yaml in the vcluster repo) skips alpha releases, so manual generation is needed during alpha/early development phases.

Core Features & Use Cases

  • Produces MDX partials from the vCluster and platform JSON schemas to keep docs in sync when automation is unavailable.
  • Leverages source files from the vCluster repository and per-version config sources to regenerate up-to-date partials for both main and versioned configurations.
  • Facilitates manual regeneration workflows during alpha/beta cycles when schema changes occur.

Quick Start

Run the generator following the documented steps in the vCluster docs to refresh the vcluster/_partials/config partials.

Frequently Asked Questions about config-partials-generator

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate MDX config partials from a vCluster JSON schema?▼

Generate MDX config partials by running the Go generator script against vCluster source files, which parses the JSON schema and outputs updated MDX documentation references for the repository.

Why are my vCluster documentation partials not updating for alpha releases?▼

vCluster documentation partials fail to update for alpha releases because the CI automation in sync-config-schema.yaml intentionally skips alpha versions, requiring manual generation when schema changes occur.

What do I need to manually update vCluster MDX documentation?▼

Manually updating vCluster MDX documentation requires cloning the vCluster repository and having a Go toolchain installed to execute the partials generator script for processing schema sources.

When do I need to manually regenerate vCluster config reference partials?▼

Manually regenerate vCluster config reference partials during alpha and beta development cycles when schema changes happen and the automated CI pipeline is unavailable or skips the release.

Does generating vCluster MDX partials work for versioned configurations?▼

Generating vCluster MDX partials supports both main and versioned configurations by leveraging per-version config sources from the vCluster repository to produce accurate, up-to-date reference documentation.

Related Skills

Explore More Content & Communication Skills→
loft-shloft-sh
11

vcluster-docs-writer

Automate writing, editing, and quality checks for vCluster Docusaurus documentation.

Official
Advanced
adoreseveradoresever
202

mintlify

Convert MDX into structured Mintlify documentation sites within Git workflows.

Community
Intermediate
tale-projecttale-project
20

auth-schema

Regenerate the Better Auth Convex schema from the auth config using the Better Auth CLI.

Official
Intermediate
langgeniuslanggenius
175

dify-docs-api-reference

Validate Dify OpenAPI reference specs against implementation code.

Official
Advanced