publish-crd-reference

Generate and maintain CRD reference pages from a configuration file.

7|7|Updated Feb 2, 2015
One-click install
npx skills add https://github.com/giantswarm/docs --skill publish-crd-reference
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: publish-crd-reference
Source: https://github.com/giantswarm/docs/tree/main/.claude/skills/publish-crd-reference
Command: npx skills add https://github.com/giantswarm/docs --skill publish-crd-reference

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires giantswarm/crd-docs-generator, and includes scripts (resource) components.

What problem does it solve?

This Skill automates the generation and maintenance of CRD reference pages, streamlining the process of adding new CRDs and ensuring all published CRDs have examples.

Core Features & Use Cases

  • CRD Reference Page Generation: Automatically generates CRD reference pages based on a configuration file.
  • CRD Registration: Registers new CRDs by adding them to the configuration file.
  • Example CRD Management: Ensures each CRD has an example CRD and manages these examples.
  • Use Case: When a new CRD is added to a project, this Skill can be used to generate the reference page, add the CRD to the configuration, and ensure an example is available.

Quick Start

Run the make update-crd-reference command to generate the CRD reference pages.

Frequently Asked Questions about publish-crd-reference

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

FAQPage Schema
How do I automate CRD reference page generation for new Custom Resource Definitions?

Automate CRD reference page generation by running the `make update-crd-reference` command, which reads a configuration file to register new CRDs and generate their corresponding reference pages automatically.

What is the process for registering new CRDs in a documentation repository?

Registering new CRDs involves adding the new Custom Resource Definition to a configuration file that specifies CRD paths and metadata, ensuring the documentation system tracks and generates pages for it.

Do I need a configuration file to manage CRD reference pages?

Yes, a configuration file is required to manage CRD reference pages. It provides the necessary CRD paths and metadata that the generation tool uses to locate definitions and build the documentation.

How does this approach ensure that published CRDs have examples?

The CRD management process ensures published CRDs have examples by checking for and managing example CRDs during the reference page generation, verifying that each Custom Resource Definition includes a practical example.

Can I use crd-docs-generator to maintain CRD reference documentation?

Yes, this Skill requires the `giantswarm/crd-docs-generator` dependency to automate the maintenance and generation of CRD reference pages in your documentation repository.

What is the best way to maintain CRD reference pages when definitions change?

The best way to maintain CRD reference pages is to run the automated update command, which regenerates the documentation based on the latest CRD configuration file, ensuring all reference pages reflect current definitions.