vcluster-docs-archiver

Archive End-of-Life vCluster documentation via Docusaurus branch and Netlify deployment.

11|57|Updated Mar 4, 2024
One-click install
npx skills add https://github.com/loft-sh/vcluster-docs --skill vcluster-docs-archiver
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: vcluster-docs-archiver
Source: https://github.com/loft-sh/vcluster-docs/tree/main/.claude/skills/vcluster-docs-archiver
Command: npx skills add https://github.com/loft-sh/vcluster-docs --skill vcluster-docs-archiver

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires curl, and includes scripts (resource) and references (resource) components.

What problem does it solve?

Archive End-of-Life vCluster or Platform documentation versions by creating dedicated archiving branches, configuring Docusaurus, and deploying standalone Netlify sites.

Core Features & Use Cases

  • Creates EOL branches and configures Docusaurus for isolated archiving.
  • Fixes links, updates Netlify deployment, and adjusts main branch state.
  • Useful when archiving content is requested to reduce main-site load and improve deployment performance.

Quick Start

Archive vCluster 0.22.0 EOL docs into a standalone Netlify deployment and update main branch links.

Frequently Asked Questions about vcluster-docs-archiver

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

FAQPage Schema
How do I archive End-of-Life Docusaurus documentation versions to a standalone site?

You can archive EOL Docusaurus documentation by creating a dedicated branch, adjusting configuration settings, and provisioning a standalone Netlify deployment. This isolates outdated content to reduce main-site load and improve deployment performance.

What is the best way to remove outdated vCluster documentation from my main site?

The best way to remove outdated vCluster documentation involves setting up an archive branch and deploying it independently via Netlify. The main branch state is then updated to link to this standalone site, keeping your primary deployment lightweight.

Do I need curl to archive EOL documentation branches?

Yes, curl is required as a dependency to archive EOL documentation branches. The workflow uses it to validate resource availability and coordinate version verification before provisioning the standalone Netlify deployment.

How does link remediation work when archiving Docusaurus sites?

Link remediation fixes broken URLs when archiving Docusaurus sites by updating the main branch to point to the new standalone Netlify deployment. This ensures users accessing the main site are correctly redirected to the archived EOL content.

Can I automate version verification for archived vCluster documentation?

Yes, version verification is enforced within the archiving workflow to validate resource availability before deployment. It ensures the correct EOL vCluster or Platform version configuration is applied to the standalone Netlify site with human review.

What are the limitations of archiving documentation with Docusaurus and Netlify?

Limitations of archiving documentation with Docusaurus and Netlify include the requirement for human review during the archiving process and strict enforcement of version-specific configurations. The workflow relies on curl and cannot deploy without validating resource availability first.