-
Notifications
You must be signed in to change notification settings - Fork 58
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
e2e: Adding e2e documentation #1759
Conversation
I move the labels t the issue, it is easier to manage them there since they live longer than prs. We can use labels for per when we don't an issue. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please squash the second commit into the first using git rebase -i
. We want to keep clean history.
Also it will be nice nice to refer to the original pr in the commit message, to give credit to the author. We want to have this info in git history.
docs/e2e.md
Outdated
- **disable**: remove workload from protection by RamenDR | ||
- **undeploy**: remove workload from the cluster | ||
|
||
## Overview of `config.yaml` File |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is also not needed for running the tests and we can work on it later.
Discussion of the config file structure should come later in the docs. We don't want to force developers to scroll long text thy don't care about, lets help to them to get what they need easily.
I think the best way to document config.yaml is to add comments in the sample config, one comment for every item.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed, PR addressing documenting options in config.yaml.sample #1767
7f56850
to
bb33bff
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Refferd from the content in PR#1477 (Authored by Jack Lu)
Use this format to get a working link in github.
Based on #1477 by Jack Lu
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice, I think we can complete this in the next iteration.
Adding the following in docs/e2e.md: * How to prepare a test config with the clusters * How to run all tests * How to run specific tests * Lists of tests Based on RamenDR#1477 by Jack Lu Signed-off-by: Parikshith <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome, thanks!
This PR addresses the following items from #1718
Referred PR #1477