-
Story
-
Resolution: Unresolved
-
Undefined
-
None
-
False
-
None
-
False
-
-
Story (Required)
As part of deprecating the kam CLI, once the code has been removed, we also need to remove kam from the documentation.
Background (Required)
Out of scope
- Removal of kam cli code in product documentation
- deprecation notices
Approach (Required)
Kam is mentioned in the following pages:
- https://docs.openshift.com/gitops/1.12/observability/monitoring/health-information-for-resources-deployment.html
- https://docs.openshift.com/gitops/1.12/gitops_workloads_infranodes/running-gitops-control-plane-workloads-on-infrastructure-nodes.html
- https://docs.openshift.com/gitops/1.12/installing_gitops/installing-openshift-gitops.html
Note: this might not all of the instances, you will need to make sure there no others.
This should only be applicable to versions of the docs where kam code has been removed (so, only the newest version). Any documentations of versions where kam is still supported should not be changed.
Dependencies
- kam cli code being removed
- deprecation notices going out
Acceptance Criteria (Mandatory)
- Docs team is made aware of every place where kam content needs to be removed
- PR's to remove kam content in docs have been merged
INVEST Checklist
Dependencies identified
Blockers noted and expected delivery timelines set
Design is implementable
Acceptance criteria agreed upon
Story estimated
Legend
Unknown
Verified
Unsatisfied
Done Checklist
- Code is completed, reviewed, documented and checked in
- Unit and integration test automation have been delivered and running cleanly in continuous integration/staging/canary environment
- Continuous Delivery pipeline(s) is able to proceed with new code included
- Customer facing documentation, API docs etc. are produced/updated, reviewed and published
- Acceptance criteria are met