Docs/enhance documentation

[mulbc]

I updated and added some docs for Ramen recipes. This should make it better for new users to get used to what Recipes are and how they work in combination with other Ramen Workload definitions

[ShyamsundarR]

Initial broad set of comments:

• DCO is required and the commits are not signed (see checks that are failing)
• We use mdl to lint markdown with rules in hack/mdl-style.rb, easiest way to run this check is to use make lint and correct the linter errors
• We are thinking of a genAI contribution guideline as below, so if the commit message and required tags can be enhanced it would help get the context/tools/prompts better (see commits and PR here: modernize: Use slices.Contains instead of loop #2231 )
• Move all CRDs to a directory under docs, named crds for example, reduces clutter in the docs directory
• I created a DRCluster CRD markdown using cursor/claude-4.5-sonnet tool and it is present here
  • The prompt used was Generate a CRD document for the API represented in the file api/v1alpha1/drcluster_types.go it should be in the style of a kubernetes custom resource definition (CRD) documentation. Use other files from internal/cotroller directory for more details regarding CRD usage, specifically files starting with drcluster name
  • The intention was to see how close to the tools/models you used was this getting to, and to understand how to improve the process
  • The learning's are that, it generates to a good extent what we need, but is missing portions that are now deprecated and further needs some cajoling to get to the right state (for example the region field is deprecated and it now moves around StorageClass labels and building peer classes as detailed in this PR), it further needs understanding of the implementation such that it can correct required sections appropriately
  • The good parts remain the same

My general feel is that, instead of reviewing the CRD files, it maybe better if Ramen authors created the same using similar schemes, such that we can address the gaps in the genAI tool and current code. If we review these files we would possily have various changes that we would suggest that may require knowledge of current implementation to rectify. If you are up to it then we can pass on the comments and let you handle the same as well.

I still have to look at the changes to non-CRD files.

GenAI WIP contribution guidelines:

## Guidelines for AI assisted or generated content

This repository permits contributions that use Predictive or Generative AI tools but is contingent on the following guidelines being followed: 

- We follow the [Linux Foundation guidelines](https://www.linuxfoundation.org/legal/generative-ai) for such contributions
- In addition to the Linux Foundation guidelines, the following guidelines are further applicable
    - [DCO](DCO) still applies and the “Signed-Off-By” label in commits indicates that you take responsibility for any generated or assisted content by AI or other tools, as per the DCO
        - The “Signed-Off-By” has to be by the contributor and not a tool
    - We require the “Generated-By” or “Assisted-By” labels, as applicable, added to commits that use such tools
        - Use “Assisted-By” when tools were used for minor edits or suggestions, typically not requiring any prompts or contexts that were used to generate the content in the commit itself
    - Use "Generated-By" when tools were used to generate substantial content, even if the generated content was later modified
        - We require an additional section in the commit that explains the prompts or background contexts provided to understand how the changes were generated
    - The value for these labels would be the tool(s) and/or model(s) used to generate the content

[mulbc]

Made the changes so the linter is happy and all commits are signed off - kept the original commit structure for easy cherry pick

[ShyamsundarR]

@mulbc request a “Generated-By: <tool/model>” in the commit messages, such that we know what was used to generate these docs.

Subsequent PRs have taken the base changes from here and massaged it for correctness and such, and we would be merging those in but if the commits here have the above tag it helps overall. Thanks!

[mulbc]

@ShyamsundarR - I added the tag to the commits and rebased

[mulbc]

@ShyamsundarR can we make progress here?