In an IT context, a "cookbook" refers to a collection of practical, step-by-step guides or recipes designed to help users accomplish specific tasks or solve common problems efficiently. These sections provide clear instructions and examples for real-world scenarios.

We want to provide cookbooks for platform engineers responsible for deploying, configuring, and managing RHDH and its plugin ecosystem, as well as for plugin developers that extend RHDH.

We begin by detailing our internal processes and how we approach these tasks, always referencing our own open-source implementation, providing links to detailed upstream or product documentation and how-to guides within that context.

These cookbooks should not replace existing documentation but extend it in a practical manner.

Guidelines

• Use clear, concise language suitable for technical audience
• Include visual aids (diagrams, screenshots) where appropriate
• Provide links to relevant upstream documentation for additional context
• Avoid embedding too much code snippets into the documentation, rather link to existing code
• Do not duplicate existing documentation.

The Cookbook entry point is: 

https://docs.google.com/document/d/1KstX6X0wY8ekvD5HOrAXUfQAWOGYaSOTgY1d5EsnbHM/edit?tab=t.0

Implementation approach

• map chapters to components and teams
• gather and inventory of existing documentation and
• tree like document structure in google docs, i.e. you can drill down into referenced document from a single starting document
• Why google docs?

• • initial phase will be very dynamic
  • you can still link to markdown docs, git repositories if you prefer

• final delivery format: TBD (techdocs, product documentation, KB articles, etc)