-
Notifications
You must be signed in to change notification settings - Fork 30
Open
Labels
kind/documentationCategorizes issue or PR as related to documentation.Categorizes issue or PR as related to documentation.
Description
Overview
This task migrates end-user documentation from the shipwright-io/operator repository to the website repository as described in SHIP-0041.
Description
Identify end-user documentation in the shipwright-io/operator repository, migrate relevant content to the website repository in appropriate sections (Concepts, How To, or Reference), and remove in-tree docs (replacing with links to website).
Only end-user documentation relevant to evaluators, developers, or administrators should be migrated. Contributor documentation and internal development docs should remain in the operator repository.
Acceptance Criteria
- All relevant end-user docs identified in operator repository
- Content migrated to appropriate website sections (Concepts, How To, or Reference)
- Hugo aliases configured for any old paths (if applicable)
- In-tree documentation removed from operator repository
- Removed documentation replaced with links to website
- All links validated and working
- PR created in operator repository to remove in-tree docs
Dependencies
- Blocks: Configure Hugo aliases (Issue 10)
- Blocked by: Audit and categorize existing documentation (Issue 3)
Technical Notes
- Review
shipwright-io/operatorrepository for documentation directories (typicallydocs/) - Identify which documentation is end-user facing vs. contributor/internal
- Migrate content to appropriate section in website repository
- Create PR in operator repository to remove migrated documentation
- Replace removed docs with README or index file that links to website
- Coordinate with operator repository maintainers for review
Generated-by: Cursor
Metadata
Metadata
Assignees
Labels
kind/documentationCategorizes issue or PR as related to documentation.Categorizes issue or PR as related to documentation.
Type
Projects
Status
No status