Open kostis-codefresh opened 2 years ago
This issue is stale because it has been open 60 days with no activity.
This issue is stale because it has been open 60 days with no activity.
Still valid
This issue is stale because it has been open 60 days with no activity.
Current documentation status
As more and more people adopt Argo Rollouts we need to ensure that the documentation pages cover all common scenarios and can guide both beginner and advanced users to progressive delivery practices.
We need different kinds of documentation for different personas. The documentation right now is mostly of the reference type and caters more to the advanced user/operator.
Some pages are really terse and make too many assumptions for the knowledge of the reader. We should improve also the concepts and architecture sections so nothing is blurry and readers know exactly what the controller is doing behind the scenes.
Suggested structure and documentation sections
I suggest we follow the Documentation system that has 4 distinct areas:
Alignment with the other Argo Projects
It would be great to match the docs with the new ArgoCD structure. We should also gather the frequent questions asked in the CNCF slack channel and make sure that they are documented.
Message from the maintainers:
Impacted by this bug? Give it a 👍. We prioritize the issues with the most 👍.