vCluster development links

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

vCluster resources

• Website
• Documentation
• Blog
• Twitter
• Slack

Contribute to the docs

Contributions from all users are encouraged.

Develop locally

1. Run npm install

   This will initially install all necessary dependencies.

2. Run npm run start

   This will continuously watch changes, build a development version and serve it locally.

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

Shared content uses two folder conventions (goal — not yet fully enforced):

• _partials/: intended for auto-generated content. Do not hand-edit generated files — changes will be overwritten on the next generation run.
• _fragments/: manually written content shared across multiple pages. Safe to edit directly.

In practice, most _partials/ content (e.g. all of platform/_partials/) is hand-maintained and safe to edit. The directories that are actually auto-generated are:

• vcluster/_partials/config/ — vCluster config reference, generated by hack/vcluster/partials/main.go
• platform/api/_partials/resources/ — Platform API reference, generated by hack/platform/partials/main.go
• vcluster_versioned_docs/version-X.Y.Z/cli/ — CLI command docs, generated by hack/vcluster-cli/main.go

When in doubt, check git log on the file before editing.

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

Generate CLI documentation

go run hack/vcluster-cli/main.go

See the CLI generator README for options.

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