docs consolidation work
This commit is contained in:
@@ -26,7 +26,7 @@ The Console presents operator dashboards for scans, policies, VEX evidence, runt
|
||||
- Auth smoke tests in `operations/auth-smoke.md`.
|
||||
- Observability runbook + dashboard stub in `operations/observability.md` and `operations/dashboards/console-ui-observability.json` (offline import).
|
||||
- Console architecture doc for layout and SSE fan-out.
|
||||
- Operator guide: `../../15_UI_GUIDE.md`. Accessibility: `../../accessibility.md`. Security: `../../security/`.
|
||||
- Operator guide: `../../15_UI_GUIDE.md`. Accessibility: `../../accessibility.md`. Security: `../../security/`.
|
||||
|
||||
## Related resources
|
||||
- ./operations/auth-smoke.md
|
||||
@@ -37,6 +37,51 @@ The Console presents operator dashboards for scans, policies, VEX evidence, runt
|
||||
- DOCS-CONSOLE-23-001 … DOCS-CONSOLE-23-003 baseline (done).
|
||||
- CONSOLE-OBS-52-001 tasks for observability updates.
|
||||
|
||||
## Implementation Status
|
||||
|
||||
### Current Objectives
|
||||
- Maintain deterministic behaviour and offline parity across releases
|
||||
- Keep documentation, telemetry, and runbooks aligned with latest sprint outcomes
|
||||
- Coordinate with backend services for feature delivery across epics
|
||||
|
||||
### Epic Milestones & Workstreams
|
||||
- Epic 2 – Policy Engine & Editor: policy editor simulation and explain UX (in progress)
|
||||
- Epic 4 – Policy Studio: registry, approvals, promotion experiences (planned)
|
||||
- Epic 5 – SBOM Graph Explorer: graph navigation, overlays, diff views (planned)
|
||||
- Epic 6 – Vulnerability Explorer: triage dashboards, findings ledger, audit exports (in progress)
|
||||
- Epic 8 – Advisory AI: advisory summaries, remediation hints with strict provenance (planned)
|
||||
- Epic 9 – Orchestrator Dashboard: job/source monitoring controls (planned)
|
||||
- Epic 11 – Notifications Studio: notifications workspace with previews, audit trails (planned)
|
||||
|
||||
### Core Capabilities
|
||||
- Angular 17 workspace with signals-based state management (@ngrx/signals)
|
||||
- Real-time status via SSE for ingestion, scanning, policy, exports
|
||||
- Authority integration: fresh-auth with DPoP-protected calls, scope enforcement
|
||||
- Accessibility compliance and offline bundle support
|
||||
- API client generator for type-safe backend integration
|
||||
|
||||
### Integration Points
|
||||
- Backend APIs: Scanner, Policy, Notify, Export Center, Attestor
|
||||
- Authority: DPoP tokens and scope validation
|
||||
- Telemetry streams: observability dashboards and SSE fan-out
|
||||
- Offline bundles: deterministic build outputs
|
||||
|
||||
### Operational Assets (Sprint 0331 · 2025-11-30)
|
||||
- Auth smoke tests: operations/auth-smoke.md
|
||||
- Observability runbook: operations/observability.md
|
||||
- Dashboard stub: operations/dashboards/console-ui-observability.json
|
||||
- Console architecture: console-architecture.md (layout, SSE fan-out)
|
||||
|
||||
### Access Control (2025-11-03)
|
||||
- Authority scopes verified before enabling uploads
|
||||
- Access-control guidance retained in docs/updates/2025-11-03-vuln-explorer-access-controls.md
|
||||
|
||||
### Coordination Approach
|
||||
- Review AGENTS.md before starting new work
|
||||
- Sync with cross-cutting teams via docs/implplan/SPRINT_*.md
|
||||
- Track tasks: DOCS-CONSOLE-23-001…003 (baseline done), CONSOLE-OBS-52-001 (observability)
|
||||
- Mirror status across sprint tracker and docs/modules/ui/TASKS.md
|
||||
|
||||
## Epic alignment
|
||||
- **Epic 2 – Policy Engine & Editor:** deliver deterministic policy authoring, simulation, and explain UX.
|
||||
- **Epic 4 – Policy Studio:** implement registry workspace, approvals, and promotion workflows.
|
||||
|
||||
@@ -1,30 +0,0 @@
|
||||
# Implementation plan — Console UI
|
||||
|
||||
## Current objectives
|
||||
- Maintain deterministic behaviour and offline parity across releases.
|
||||
- Keep documentation, telemetry, and runbooks aligned with the latest sprint outcomes.
|
||||
|
||||
## Workstreams
|
||||
- Backlog grooming: reconcile open stories in ../../TASKS.md with this module's roadmap.
|
||||
- Implementation: collaborate with service owners to land feature work defined in SPRINTS/EPIC docs.
|
||||
- Validation: extend tests/fixtures to preserve determinism and provenance requirements.
|
||||
|
||||
## Epic milestones
|
||||
- **Epic 2 – Policy Engine & Editor:** deliver policy editor simulation and explain UX.
|
||||
- **Epic 4 – Policy Studio:** build registry, approvals, and promotion experiences.
|
||||
- **Epic 5 – SBOM Graph Explorer:** implement graph navigation, overlays, and diff views.
|
||||
- **Epic 6 – Vulnerability Explorer:** surface triage dashboards, findings ledger, and audit exports.
|
||||
- **Epic 8 – Advisory AI:** integrate advisory summaries and remediation hints with strict provenance.
|
||||
- **Epic 9 – Orchestrator Dashboard:** expose job/source monitoring controls.
|
||||
- **Epic 11 – Notifications Studio:** provide notifications workspace with previews and audit trails.
|
||||
- Track supporting tasks (e.g., DOCS-CONSOLE-23-001, CONSOLE-OBS-52-001) in ../../TASKS.md.
|
||||
|
||||
## Coordination
|
||||
- Review ./AGENTS.md before picking up new work.
|
||||
- Sync with cross-cutting teams noted in `/docs/implplan/SPRINT_*.md`.
|
||||
- Update this plan whenever scope, dependencies, or guardrails change.
|
||||
|
||||
## Sprint alignment (2025-11-30)
|
||||
- Current doc refresh tracked in `docs/implplan/SPRINT_0331_0001_0001_docs_modules_ui.md`; statuses mirrored in `docs/modules/ui/TASKS.md`.
|
||||
- Observability evidence for latest demo lives in `operations/observability.md` with Grafana JSON stub under `operations/dashboards/`.
|
||||
- Keep future doc/ops changes mirrored across sprint, TASKS, and module front doors to prevent drift.
|
||||
Reference in New Issue
Block a user