Details
-
Epic
-
Resolution: Done
-
Normal
-
None
-
None
-
None
-
Improve GitOps Operator Documentation
-
False
-
None
-
False
-
To Do
-
100
-
100%
Description
Epic Goal
- To improve the GitOps Operator Documentation at https://docs.openshift.com/container-platform/4.12/cicd/gitops/understanding-openshift-gitops.html
Why is this important?
- We have documentation in many different places (ex: GitOps usage guide, argocd-operator docs) that is relevant to our product but not included in our official documentation. To someone unfamiliar with all these other locations for documentation it would be confusing and frustrating, and there's no way for someone to know what's officially supported and what isn't.
Scenarios
- ...
Acceptance Criteria (Mandatory)
- Communicate with the docs team to make stories and come up with documentation to go in docs.openshift.com
- All issues in this doc must be addressed (either as documentation added to our official docs or a reason as to why it won't be included in our docs)
Dependencies (internal and external)
- Docs team
Previous Work (Optional):
- …
Open questions::
- …
Done Checklist
- Acceptance criteria are met
- PR's are made to official docs and merged