菜单
Guide for adding and editing chapters in the kubectl-mtv technical guide (Jekyll + GitHub Pages). Use when writing documentation, adding chapters, or updating the guide table of contents.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Step-by-step guide for syncing copy-offload (XCOPY) storage vendor drivers and their credential/secret properties between upstream kubev2v/forklift and kubectl-mtv. Use when adding a new offload vendor, updating vendor-specific secret fields, or auditing for upstream changes.
Step-by-step guide for updating the kubev2v/forklift Go dependency in kubectl-mtv. Use when bumping the forklift version, syncing settings or CRD types, or checking for upstream changes.
Guide for adding or modifying MCP tools and understanding command discovery in kubectl-mtv. Use when working on the MCP server, adding new tools, or changing how commands are exposed to AI assistants.
Guide for writing and running tests in kubectl-mtv, including Go unit tests, MCP e2e tests (Python/pytest), and linting. Use when adding tests, running the test suite, or debugging test failures.
Step-by-step guide for adding new CLI commands to kubectl-mtv. Use when creating new subcommands, adding verbs or resources, or wiring Cobra commands into the command tree.
Reference for Forklift CRD types, GVR constants, K8s client patterns, CRUD operations, and inventory API usage in kubectl-mtv. Use when working with Forklift resources, K8s API calls, or the inventory service.
| name | guide-authoring |
| description | Guide for adding and editing chapters in the kubectl-mtv technical guide (Jekyll + GitHub Pages). Use when writing documentation, adding chapters, or updating the guide table of contents. |
The technical guide lives in guide/ and is published as a Jekyll site on GitHub Pages.
guide/
├── README.md # Landing page + table of contents
├── 01-overview-of-kubectl-mtv.md
├── 02-installation-and-prerequisites.md
├── ...
└── 28-karl-kubernetes-affinity-rule-language-reference.md
Jekyll config: _config.yml (project root). Theme: minima. Markdown: kramdown + Rouge.
Name it guide/NN-slug.md where NN is the next number (currently 01-28, so next is 29):
---
layout: page
title: "Chapter 29: Your Chapter Title"
---
Content here...
Add the chapter to guide/README.md in the appropriate section. The TOC is maintained manually.
bundle install
bundle exec jekyll serve
The pages.yml workflow triggers on changes to guide/**, _config.yml, _includes/**, or Gemfile and deploys to GitHub Pages automatically.
Always use long flags in examples:
kubectl-mtv get plans --namespace openshift-mtv --output json --query "where warmMigration = true"
Never use short flags (-n, -o, -q). Long flags are self-documenting and clearer for readers.
Use fenced code blocks with language hints:
```bash
kubectl-mtv get inventory vm --provider my-vsphere --output json
```
Link to other chapters with relative paths:
See [Chapter 5: Providers](05-providers.md) for details.
Every chapter needs:
---
layout: page
title: "Chapter NN: Title"
---
The permalink is derived automatically from the filename: /:basename/.
From _config.yml:
include: [guide] -- ensures the guide/ directory is processedexclude: [cmd/, pkg/, ...] -- source code directories are excludedguide/: layout: page, permalink: /:basename/header_pages: [guide/README.md] -- guide appears in the site headerPush to main triggers .github/workflows/pages.yml:
bundle installjekyll build with the correct base pathactions/deploy-pages