doc: Enhance documentation for Recipe #2339
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
asn1809
requested review from
BenamarMk,
ShyamsundarR and
raghavendra-talur
as code owners
asn1809
force-pushed
the
enhance-documentation
branch
from
41e7b48 to
2a46f2e
Compare
asn1809
force-pushed
the
enhance-documentation
branch
from
2a46f2e to
fe8bb20
Compare
Signed-off-by: Chris Blum <[email protected]>
asn1809
force-pushed
the
enhance-documentation
branch
2 times, most recently
from
e38b739 to
e24734a
Compare
Updating the recipe document with examples and comprehensive notes. Signed-off-by: Annaraya Narasagond <[email protected]>
asn1809
force-pushed
the
enhance-documentation
branch
from
e24734a to
7ce882f
Compare
nirs
reviewed
Nov 25, 2025
docs/recipe.md
Outdated
| applications. While Ramen supports multiple workload | ||
| protection methods (GitOps, discovered applications, and | ||
| Recipes), Recipes are specifically designed for applications | ||
| that require: |
Member
There was a problem hiding this comment.
Text is too narrow. Please wrap lines around 80 characters for easier to read text. See other docs like docs/e2e.md for example.
docs/recipe.md
Outdated
|
|
||
| ## Introduction | ||
|
|
||
| Recipes are part of Ramen's OpenShift-native Disaster |
Member
There was a problem hiding this comment.
We should not have OpenShift in upstream docs. We can use Kubernetes instead.
| Recovery ecosystem, providing vendor-supplied or custom disaster recovery | ||
| specifications for complex stateful applications. While Ramen supports | ||
| multiple workload protection methods (GitOps, discovered applications), | ||
| Recipes are specifically designed for applications that require: |
Member
There was a problem hiding this comment.
Lets squash this commit into the first one, it fixes issues in the first commit. We don't want to keep this in the project git history. You can squash and keep multiple signed-off-by if this was reason you made the changes in a different commit.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR: