Update documentation for 75-source catalog and mirror management
connectors.md: categorized index of all 75 sources across 14 categories with descriptions, auth requirements, priorities, regions, and status. FSTEC BDU, NKCKI, and Kaspersky ICS promoted from beta to stable. architecture.md: updated source families (75 sources, 14 categories), added mirror domain management API (12 endpoints) to REST APIs section. mirrors.md: added MirrorExportScheduler docs, multi-value filter support (sourceCategory/sourceTag shorthands), mirror config UI sections (wizard, dashboard, catalog integration). docker.md: added section 7 with mirror env var reference (11 vars), domain config via env vars, filter shorthand documentation. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
@@ -426,7 +426,7 @@ Completion criteria:
|
||||
- [x] Mirror consumer (Concelier connector) processes new categories correctly (ResolveFilters handles comma-separated multi-category values)
|
||||
|
||||
### TASK-011 - Documentation Update
|
||||
Status: TODO
|
||||
Status: DONE
|
||||
Dependency: TASK-001 through TASK-010
|
||||
Owners: Documentation author
|
||||
|
||||
@@ -437,9 +437,9 @@ Update module documentation:
|
||||
- `docs/operations/deployment/docker.md` — document mirror configuration env vars
|
||||
|
||||
Completion criteria:
|
||||
- [ ] Connector index updated with all new sources
|
||||
- [ ] Mirror setup guide includes UI-based configuration
|
||||
- [ ] Source category taxonomy documented
|
||||
- [x] Connector index updated with all new sources (75 sources across 14 categories, organized by category with descriptions)
|
||||
- [x] Mirror setup guide includes UI-based configuration (wizard, dashboard, catalog integration documented in mirrors.md sections 5.1-5.3)
|
||||
- [x] Source category taxonomy documented (14 categories enumerated in connectors.md, architecture.md, and mirrors.md)
|
||||
|
||||
---
|
||||
|
||||
@@ -449,6 +449,7 @@ Completion criteria:
|
||||
| 2026-03-15 | Sprint created with 11 tasks for full mirror source completeness. | Planning |
|
||||
| 2026-03-15 | Expanded to 16 tasks. Added TASK-005 (multi-value filter model), TASK-006 (domain CRUD API, 12 endpoints), TASK-006b (export scheduler), TASK-007a (domain builder wizard), TASK-007b (mirror dashboard), TASK-007c (catalog mirror header). Original TASK-005/006/007 were too generic — now they cover the full distro-to-mirror operator journey. | Planning |
|
||||
| 2026-03-15 | TASK-007 DONE: Updated CATEGORY_ORDER (12 -> 14 entries), added CATEGORY_DESCRIPTIONS map, added category descriptions to UI headers, added getCategoryDescription() method. TASK-010 DONE: Added SupportedCategories to MirrorDistributionOptions, extended ResolveFilters for comma-separated sourceCategory/sourceTag, added Ics and PackageManager to SourceCategory enum, reclassified 6 sources. | Developer |
|
||||
| 2026-03-15 | TASK-011 DONE: Updated 4 documentation files. connectors.md: rewrote from flat table to categorized index covering all 75 sources across 14 categories with descriptions, auth, priority, regions, and status (FSTEC BDU/NKCKI/Kaspersky ICS promoted to stable). architecture.md: updated source families section (75 sources, 14 categories), added mirror domain management API (12 endpoints) to REST APIs section. mirrors.md: added MirrorExportScheduler docs (staleness detection, config), multi-value filter support (sourceCategory/sourceTag/sourceVendor shorthands), mirror config UI sections (wizard, dashboard, catalog integration), renumbered subsequent sections. docker.md: added section 7 with mirror env var reference table (11 vars), domain config via env vars example, filter shorthand documentation. | Documentation |
|
||||
|
||||
## Decisions & Risks
|
||||
- **Commercial feeds** (Snyk, Sonatype OSS Index, VulnDB) intentionally excluded — they require paid API keys and license agreements incompatible with self-hosted offline-first posture. Can be added as `SourceType.Commercial` with clear license gates later.
|
||||
|
||||
Reference in New Issue
Block a user