-
Notifications
You must be signed in to change notification settings - Fork 66
Docs/enhance documentation #2332
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
|
Initial broad set of comments:
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: |
7faffa0 to
37ff9c5
Compare
|
Made the changes so the linter is happy and all commits are signed off - kept the original commit structure for easy cherry pick |
|
@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! |
37ff9c5 to
7b7d235
Compare
Signed-off-by: Chris Blum <[email protected]> Generated-By: Claude, Sonnet 4.5
Signed-off-by: Chris Blum <[email protected]> Generated-By: Claude, Sonnet 4.5
Signed-off-by: Chris Blum <[email protected]> Generated-By: Claude, Sonnet 4.5
Signed-off-by: Chris Blum <[email protected]> Generated-By: Claude, Sonnet 4.5
Signed-off-by: Chris Blum <[email protected]> Generated-By: Claude, Sonnet 4.5
7b7d235 to
97c7829
Compare
|
@ShyamsundarR - I added the tag to the commits and rebased |
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