olm-book icon indicating copy to clipboard operation
olm-book copied to clipboard

Documentation for OLM

Operator Lifecycle Book

Adding a new page

  • Clone this repo
  • Make a new markdown doc in docs
    • Example: docs/what-does-olm-enable.md
  • Update or create a new link in index.md to point to the doc in docs
    • The link should be https://operator-framework.github.io/olm-book/docs/ + doc name (no .md)
    • Example: [What does OLM enable](https://operator-framework.github.io/olm-book/docs/what-does-olm-enable)?
  • Make a PR with both changes
  • See the updated links in https://operator-framework.github.io/olm-book

You can also use the in-browser editor to make PRs!