Skip to content

chore: add config-partials-generator skill#1778

Merged
Piotr1215 merged 3 commits intomainfrom
devops-622/add-config-partials-skill
Feb 27, 2026
Merged

chore: add config-partials-generator skill#1778
Piotr1215 merged 3 commits intomainfrom
devops-622/add-config-partials-skill

Conversation

@Piotr1215
Copy link
Copy Markdown
Contributor

Content Description

Adds a new AI skill that documents the manual config partials generation workflow. The sync-config-schema automation in the vcluster repo skips alpha releases by design, so manual generation is needed during early development phases. This skill codifies the exact steps so future agents can execute it without needing a brief.

Preview Link

N/A — skill file only, no docs content changes.

Internal Reference

References DEVOPS-622

AI review: mention @claude in a comment to request a review or changes. See CONTRIBUTING.md for available commands.

@netlify /docs

Codifies the manual config generation workflow for when the
sync-config-schema automation skips alpha releases. Documents
source files, generator commands, and the platform generator
caveat (PR #1663 must be merged first).
@Piotr1215 Piotr1215 requested a review from a team as a code owner February 26, 2026 10:03
@netlify
Copy link
Copy Markdown

netlify bot commented Feb 26, 2026

Deploy Preview for vcluster-docs-site ready!

Name Link
🔨 Latest commit 9b9dde8
🔍 Latest deploy log https://app.netlify.com/projects/vcluster-docs-site/deploys/69a050806ab9f00008924aa3
😎 Deploy Preview https://deploy-preview-1778--vcluster-docs-site.netlify.app/docs
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions
Copy link
Copy Markdown
Contributor

@Piotr1215
Copy link
Copy Markdown
Contributor Author

@claude review according to best practices of creating skills

@claude
Copy link
Copy Markdown

claude bot commented Feb 26, 2026

Claude finished @Piotr1215's task in 1m 39s —— View job


Review: config-partials-generator skill

Tasks:

  • Gather context
  • Read the new skill file
  • Compare against existing skills for consistency
  • Review against skill best practices
  • Post review findings

Summary

The skill documents a useful, well-understood workflow and is a solid starting point. There is one critical structural issue and several improvements that would bring it in line with the other skills in this repo.


Critical: Missing YAML frontmatter

Every registerable skill in this repo has a YAML frontmatter block. Without it, Claude Code cannot identify or invoke this skill as a slash command.

Compare vcluster-docs-archiver/SKILL.md:

---
name: vcluster-docs-archiver
description: Archive End-of-Life vCluster documentation versions. Use this skill when creating EOL documentation branches for vCluster or Platform versions. Handles branch creation, Docusaurus configuration, link fixing, Netlify deployment, and main branch updates.
---

And vcluster-docs-writer/SKILL.md:

---
name: vcluster-docs-writer
description: Write and edit vCluster Docusaurus documentation. Use this skill when working with .mdx or .md files in the vcluster-docs repository. Handles vale linting, partials discovery, link validation, versioned docs, and release processes.
context: fork
---

The new skill needs a frontmatter block like:

---
name: config-partials-generator
description: Generate MDX config reference partials from vCluster JSON schema. Use when automation is skipped for alpha releases or when manually refreshing config docs.
---

Fix this →


Improvements

1. Hardcoded ~/loft/vcluster path (lines 17, 49, 59, 63, 103)

The path ~/loft/vcluster is a single developer's local convention. An agent running this skill in a different environment will fail silently or use the wrong repo. Other skills avoid this by either:

  • Asking the user to confirm the path at the start
  • Using a variable placeholder like <VCLUSTER_REPO>

Recommend adding to Prerequisites:

- Local clone of `vcluster` repo (default: `~/loft/vcluster`, adjust if different)

And use <VCLUSTER_REPO> as a variable in code blocks.

2. Step 3 missing working directory context (line 71)

go mod tidy && go mod vendor

Where should this run? The vcluster-docs repo root is implied, but not stated. Compare with k8s-compat-matrix skill which always specifies cd before commands. Either add cd <vcluster-docs-repo> before this block or move it after the cd in Step 2.

3. PR #1663 reference will become stale (lines 106–112)

The conditional "Do NOT run the platform partials generator unless PR #1663 has been merged" is time-sensitive — once merged, this becomes misleading. Options:

  • Add `` as a maintenance note
  • Replace with a runtime check: gh pr view 1663 --json state --jq '.state' and let the agent decide
  • Or move the PR guard into a separate "Platform partials" section with an explicit "Check before running" header so it's easier to delete once resolved

4. Workflow doesn't close the loop (after line 130)

After Step 5 ("Review output"), the skill stops. Other skills complete the cycle. Add a Step 7 that covers:

  • Create a branch (e.g., chore/update-config-partials-vX.Y.Z)
  • Stage and commit the changed files in vcluster/_partials/config/ and configsrc/
  • Open a PR

5. "Do Not" section style (line 125+)

Other skills use ⚠️ or 🚨 markers and Never-Do / Always-Do paired sections for scannability. The current "Do Not" list is plain text bullets. Minor polish to match conventions.


What's Working Well

  • The Automation Gap section is excellent — it explains exactly why the manual workflow exists and maps the CI logic precisely
  • Expected warnings in Step 5 is a thoughtful addition that prevents agents from treating non-errors as errors
  • The Source Files table gives a clear map of the system before diving in
  • When to Use trigger phrases are specific and actionable

add yaml frontmatter for skill registration, replace hardcoded
~/loft/vcluster with <VCLUSTER_REPO> variable, add working directory
context to steps 2-3, make pr #1663 guard a runtime check instead
of static text, add step 7 for commit/pr workflow, rename "do not"
to "never do" for consistency with other skills.
@Piotr1215 Piotr1215 merged commit faf6079 into main Feb 27, 2026
4 checks passed
@Piotr1215 Piotr1215 deleted the devops-622/add-config-partials-skill branch February 27, 2026 11:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant