yaacov/guide-authoring
.cursor/skills/guide-authoring/SKILL.md
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.
$ install --global
skillsauthnpx skillsauth add yaacov/kubectl-mtv guide-authoringInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Apr 17, 2026, 10:22 AM5.3s1 file scanned
SKILL.md
- 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.
Guide Authoring
The technical guide lives in guide/ and is published as a Jekyll site on GitHub Pages.
Structure
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.
Adding a New Chapter
1. Create the file
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...
2. Update the TOC
Add the chapter to guide/README.md in the appropriate section. The TOC is maintained manually.
3. Verify locally (optional)
bundle install
bundle exec jekyll serve
4. Push to main
The pages.yml workflow triggers on changes to guide/**, _config.yml, _includes/**, or Gemfile and deploys to GitHub Pages automatically.
Writing Conventions
Full Flag Notation
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.
Code Blocks
Use fenced code blocks with language hints:
```bash
kubectl-mtv get inventory vm --provider my-vsphere --output json
```
Cross-References
Link to other chapters with relative paths:
See [Chapter 5: Providers](05-providers.md) for details.
Front Matter
Every chapter needs:
---
layout: page
title: "Chapter NN: Title"
---
The permalink is derived automatically from the filename: /:basename/.
Jekyll Config Highlights
From _config.yml:
include: [guide]-- ensures theguide/directory is processedexclude: [cmd/, pkg/, ...]-- source code directories are excluded- Defaults for
guide/:layout: page,permalink: /:basename/ header_pages: [guide/README.md]-- guide appears in the site header
Deployment
Push to main triggers .github/workflows/pages.yml:
- Checkout + Ruby 3.1 +
bundle install jekyll buildwith the correct base path- Deploy to GitHub Pages via
actions/deploy-pages
Related Skills
yaacov/update-forklift-version
development
VerifiedTrustedCommunity
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.
12SKILL.mdUpdated Apr 17, 2026
yaacov/release-workflow
tools
VerifiedTrustedCommunity
Reference for building, releasing, publishing images, and deploying kubectl-mtv. Use when creating releases, building binaries or container images, deploying to OpenShift, or updating the Krew plugin index.
12SKILL.mdUpdated Apr 17, 2026
yaacov/project-testing
tools
VerifiedTrustedCommunity
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.
12SKILL.mdUpdated Apr 17, 2026
yaacov/mcp-tool-development
tools
VerifiedTrustedCommunity
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.
12SKILL.mdUpdated Apr 17, 2026