Documentation Gap Plan

This page turns the official documentation gap review into executable work. The goal is not to create pages for their own sake, but to close the production-adoption gaps first and then improve long-term documentation maintenance.

Current Coverage

Area	Current State	Next Step
Installation	Helm installation and console access are documented	Add install troubleshooting, upgrade, rollback, uninstall
Tutorials	Backup/restore, disaster recovery, and drills are covered	Continue filling key state screenshots
API	REST, WebSocket, and statistics APIs exist	Add authentication, error codes, OpenAPI generation
Security	README has a vulnerability reporting entry	Build a Security section
Compatibility	Dependency information is spread across code and Chart files	Build a compatibility matrix
Operations	Production deployment and basic troubleshooting exist	Add monitoring, capacity planning, lifecycle operations
Versioning	Only current exists	Enable Docusaurus versioning before stable releases

P0: Production Adoption Blockers

Compatibility Matrix

Delivery page: Compatibility Matrix

Acceptance criteria:

• Document the Chart, operator, server, and web image version relationship.
• Document the validation status of Kubernetes, Velero, object storage, and CSI/PV recovery.
• Clearly mark unverified combinations as unverified.

Security Section

Delivery pages:

• Security Overview
• RBAC and Permissions
• API Authentication
• Network and Ports
• Secrets and Credentials

Acceptance criteria:

• Explain Server API authentication, JWT, WebSocket tokens, and public endpoints.
• Explain Operator and Server permissions in the management cluster.
• Explain minimum permissions and storage boundaries for remote cluster credentials.
• Explain webhook TLS, License Secret, object storage credentials, and image pull secrets.

Production Lifecycle

Delivery pages:

• Upgrade
• Rollback
• Uninstall

Acceptance criteria:

• Each page includes pre-checks, commands, verification commands, and risk notes.
• Long-running operations are called out as unsafe upgrade/uninstall windows.
• CRD, object storage, and remote cluster data retention are clearly documented.

P1: Official Documentation Completeness

Task	Delivery Page
Error codes	Error Codes
OpenAPI generation	OpenAPI Generation
Install troubleshooting	Install Troubleshooting
FAQ	FAQ
Monitoring	Monitoring
Capacity planning	Capacity Planning
Release process	Release Process

Versioned Documentation Strategy

The site is still building its first open-source documentation baseline, so docs are not frozen immediately. Before stable release:

1. Choose the public version, such as v2.3 or v1.0.
2. Freeze the current docs with Docusaurus versioning.
3. Keep current as the next development version.
4. Add the version dropdown and lifecycle policy.
5. Verify English/Chinese version switching, search index, and Edit this page.

Maintenance Rules

• User-visible features must update concepts, tutorials, API, or reference pages.
• API contract changes must update OpenAPI, REST API docs, and error codes.
• Chart, image, or deployment parameter changes must update installation, upgrade, and compatibility docs.
• Security, permission, or authentication changes must update the Security section.
• New screenshots should be shared by Chinese and English pages to avoid drift.