operator-framework / operator-controller

Apache License 2.0
28 stars 47 forks source link

[epic] v1.0.0 Documentation #959

Open joelanford opened 1 week ago

joelanford commented 1 week ago

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:

  1. What is OLMv1?
  2. Why are we building OLMv1?
  3. How to install OLMv1 in an upstream Kubernetes cluster
    • What are the prerequisites?
  4. Quickstart
    • Install
    • Create a catalog
    • Create a ClusterExtension
    • Check installation status
    • Upgrade
    • Uninstall
  5. 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
m1kola commented 3 days ago

I just created #984 about OLMv1 limitations which we might want to include into this epic as well.