What happened
PR #242 (#242) updated quay.io image references from enterprise-contract to conforma. However, multiple other references to the old naming remain across the documentation:
- enterprisecontract.dev URLs (hitchhikers-guide.adoc, 4 occurrences) — links to old domain for CLI docs, policy authoring, policy input, and configuration pages
- github.com/enterprise-contract (slsa.adoc:156) — GitHub org link that should likely point to github.com/conforma
- enterprise-contract-service Kubernetes namespace (custom-data.adoc, lines 37, 64, 227) — kubectl commands referencing old namespace
- verify-enterprise-contract Tekton task name (getting-started.adoc:19, reproducing-a-konflux-conforma-report.adoc:14)
- pipeline-enterprise-contract quay.io path and GitHub path (getting-started.adoc:18, 22)
The glossary terms (Enterprise Contract, Enterprise Contract Policy) may be intentionally retained since they document the former name.
What could go better
The review process (whether human or automated) could have identified these residual references and flagged them — either as in-scope for the same PR or explicitly documented as known follow-up work. The enterprisecontract.dev URLs are particularly concerning because if the old domain is retired or stops redirecting, documentation links will break.
There is some uncertainty here: some references (like Kubernetes namespace names and Tekton task names) may refer to external resources that genuinely still use the old naming and cannot be updated in documentation alone. The GitHub org URL and enterprisecontract.dev domain references, however, are almost certainly stale.
Confidence: Medium-high that enterprisecontract.dev URLs and github.com/enterprise-contract need updating. Medium confidence that Kubernetes namespace and task name references should be updated (depends on whether the upstream resources were also renamed).
Proposed change
Audit and update remaining enterprise-contract references in the documentation:
- Replace
enterprisecontract.dev URLs in modules/ROOT/pages/hitchhikers-guide.adoc with equivalent conforma.dev URLs (verify the new URLs exist first)
- Update
github.com/enterprise-contract in modules/ROOT/pages/slsa.adoc to github.com/conforma
- Verify whether
enterprise-contract-service Kubernetes namespace has been renamed, and if so, update references in modules/ROOT/pages/custom-data.adoc
- Verify whether
verify-enterprise-contract Tekton task and pipeline-enterprise-contract pipeline have been renamed, and if so, update references in getting-started.adoc and reproducing-a-konflux-conforma-report.adoc
- Consider adding a redirect or note if some old references must be kept for backward compatibility
Validation criteria
- Running
grep -r 'enterprise.contract' modules/ returns only intentionally retained references (e.g., glossary definitions explaining the former name)
- All documentation URLs resolve to valid pages (no 404s from retired domains)
- Code examples in documentation use current namespace/task names that match the deployed infrastructure
Generated by retro agent from #242
What happened
PR #242 (#242) updated quay.io image references from
enterprise-contracttoconforma. However, multiple other references to the old naming remain across the documentation:The glossary terms (Enterprise Contract, Enterprise Contract Policy) may be intentionally retained since they document the former name.
What could go better
The review process (whether human or automated) could have identified these residual references and flagged them — either as in-scope for the same PR or explicitly documented as known follow-up work. The
enterprisecontract.devURLs are particularly concerning because if the old domain is retired or stops redirecting, documentation links will break.There is some uncertainty here: some references (like Kubernetes namespace names and Tekton task names) may refer to external resources that genuinely still use the old naming and cannot be updated in documentation alone. The GitHub org URL and enterprisecontract.dev domain references, however, are almost certainly stale.
Confidence: Medium-high that enterprisecontract.dev URLs and github.com/enterprise-contract need updating. Medium confidence that Kubernetes namespace and task name references should be updated (depends on whether the upstream resources were also renamed).
Proposed change
Audit and update remaining
enterprise-contractreferences in the documentation:enterprisecontract.devURLs inmodules/ROOT/pages/hitchhikers-guide.adocwith equivalentconforma.devURLs (verify the new URLs exist first)github.com/enterprise-contractinmodules/ROOT/pages/slsa.adoctogithub.com/conformaenterprise-contract-serviceKubernetes namespace has been renamed, and if so, update references inmodules/ROOT/pages/custom-data.adocverify-enterprise-contractTekton task andpipeline-enterprise-contractpipeline have been renamed, and if so, update references ingetting-started.adocandreproducing-a-konflux-conforma-report.adocValidation criteria
grep -r 'enterprise.contract' modules/returns only intentionally retained references (e.g., glossary definitions explaining the former name)Generated by retro agent from #242