vCluster development links

• vCluster repo
• vCluster open issues
• vCluster releases and release notes

vCluster resources

• Website
• Documentation
• Blog
• Twitter
• Slack

Contribute to the docs

We encourage contributions from all users!

Quick start for contributing using DevPod

The quickest way to start contributing:

1. Install DevPod
2. Open this repository in DevPod:

This sets up a complete development environment with all dependencies.

Other ways to contribute

• Create a docs issue.
• Open a pull request.

  • Use the GitHub web UI to update a single page.

  • To update several pages or add new pages:

    • Fork the repo.
    • Clone your fork.
    • Ceate a local working branch.
    • Commit your changes.
    • Push your changes.
    • Create a pull request.

    See the GitHub Pull requests documentation for specific guides.

The docs site uses Docusaurus. See Contribute to the vCluster docs for how to build the site locally.

Content locations:

• vcluster: vCluster content
• platform: vCluster Platform content

Generate new vCluster version

npm run docusaurus docs:version:vcluster 0.22.0

Generate new Platform version

npm run docusaurus docs:version:platform 4.3.0

Generate vCluster partials

go run hack/vcluster/partials/main.go

Generate platform partials

go run hack/platform/partials/main.go

Wrap glossary terms

To automatically wrap glossary terms in MDX files with <GlossaryTerm> components:

# Wrap terms in a single file
npm run wrap-glossary vcluster/deploy/basics.mdx

# Wrap terms in all files in a directory (recursive)
npm run wrap-glossary vcluster/deploy/

# Or use the script directly
node scripts/wrap-glossary-terms.js platform/understand/

The script will:

• Only wrap terms that exist in src/data/glossary.yaml
• Only wrap the first occurrence of each term in a document
• Respect the glossary type setting (vcluster, platform, or both)
• Skip terms in front matter, code blocks, links, and HTML/JSX tags
• Preserve the original case of matched terms