Documentation is necessary in order to properly release a project, announce it to the world, and drive adoption. Good documentation is also very helpful for users and maintainers to understand design intent, which can sometimes help explain to users why they see certain behaviors or to maintainers, provide context around questions in code.
As part of a v1.0 release, we need to have documentation that covers the following:
What is OLMv1?
Why are we building OLMv1?
How to install OLMv1 in an upstream Kubernetes cluster
What are the prerequisites?
Quickstart
Install
Create a catalog
Create a ClusterExtension
Check installation status
Upgrade
Uninstall
Reference
Overall architecture diagram and description
catalogd
ClusterCatalog API Reference
operator-controller
ClusterExtension API Reference
How To:
Pin to a specific version
Accept automatic upgrades within a specific z-stream
Accept automatic upgrades within a specific channel
Documentation is necessary in order to properly release a project, announce it to the world, and drive adoption. Good documentation is also very helpful for users and maintainers to understand design intent, which can sometimes help explain to users why they see certain behaviors or to maintainers, provide context around questions in code.
As part of a v1.0 release, we need to have documentation that covers the following: