Skip to content
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

Merged
merged 1 commit into from
Jan 28, 2025
Merged

e2e: Adding e2e documentation #1759

merged 1 commit into from
Jan 28, 2025

Conversation

parikshithb
Copy link
Member

@parikshithb parikshithb commented Jan 22, 2025

This PR addresses the following items from #1718

  1. How to prepare a test config with the clusters
  2. How to run all tests
  3. How to run specific tests
  4. How to run specific test steps (removed)
  5. How to build e2e executable (removed)

Referred PR #1477

@parikshithb parikshithb marked this pull request as draft January 22, 2025 09:47
@parikshithb parikshithb self-assigned this Jan 22, 2025
@parikshithb parikshithb added the documentation Improvements or additions to documentation label Jan 22, 2025
@parikshithb parikshithb requested a review from nirs January 22, 2025 09:48
@nirs nirs removed the documentation Improvements or additions to documentation label Jan 22, 2025
@nirs
Copy link
Member

nirs commented Jan 22, 2025

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.

Copy link
Member

@nirs nirs left a 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 Show resolved Hide resolved
docs/e2e.md Outdated Show resolved Hide resolved
docs/e2e.md Outdated Show resolved Hide resolved
docs/e2e.md Outdated Show resolved Hide resolved
docs/e2e.md Outdated
- **disable**: remove workload from protection by RamenDR
- **undeploy**: remove workload from the cluster

## Overview of `config.yaml` File
Copy link
Member

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.

Copy link
Member Author

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

docs/e2e.md Outdated Show resolved Hide resolved
docs/e2e.md Outdated Show resolved Hide resolved
docs/e2e.md Outdated Show resolved Hide resolved
docs/e2e.md Outdated Show resolved Hide resolved
docs/e2e.md Outdated Show resolved Hide resolved
@parikshithb parikshithb force-pushed the e2e_docs branch 2 times, most recently from 7f56850 to bb33bff Compare January 24, 2025 14:29
@parikshithb parikshithb marked this pull request as ready for review January 24, 2025 15:03
Copy link
Member

@nirs nirs left a 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

Copy link
Member

@nirs nirs left a 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.

docs/e2e.md Outdated Show resolved Hide resolved
docs/e2e.md Show resolved Hide resolved
docs/e2e.md Outdated Show resolved Hide resolved
docs/e2e.md Outdated Show resolved Hide resolved
docs/e2e.md Outdated Show resolved Hide resolved
docs/e2e.md Show resolved Hide resolved
docs/e2e.md Show resolved Hide resolved
docs/e2e.md Outdated Show resolved Hide resolved
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]>
Copy link
Member

@nirs nirs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome, thanks!

@nirs nirs mentioned this pull request Jan 16, 2025
8 tasks
@nirs nirs merged commit bf09b4c into RamenDR:main Jan 28, 2025
44 of 45 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants