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

fix: Add more documenation to project #16

Merged
merged 21 commits into from
Apr 23, 2024

Conversation

mateusoliveira43
Copy link
Contributor

@mateusoliveira43 mateusoliveira43 commented Mar 12, 2024

Why the changes were made

Add more documentation to the project:

  • separated documentation in README to docs folder
  • created contribution documentation
  • added more info in architecture documentation

Also:

  • NAC dinamically knows where OADP is installed
  • created OADP version compatibility check CI job
  • fixed minor problems in NAC code

Blocked by openshift/oadp-operator#1370

Fixes #19

How the changes were made

Studied how will be the integration of NAC to OADP operator and wrote documentation/created commands to facilitate updates of NAC in OADP and easily test NAC in OADP

How to test the changes made

Read documentation and check if it clear and useful.

Deploy OADP operator with NAC from this branch, following contribution documentation.

NAC objects deployed by OADP operator should be the same as the ones created by make build-installer

README.md Outdated Show resolved Hide resolved
@mateusoliveira43 mateusoliveira43 marked this pull request as draft March 25, 2024 15:12
@mateusoliveira43 mateusoliveira43 changed the title fix: Add contribution documenation to project fix: Add more documenation to project Mar 26, 2024
Makefile Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Copy link

openshift-ci bot commented Apr 9, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mateusoliveira43

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the approved label Apr 9, 2024
.github/workflows/oadp-compatibility-check.yml Outdated Show resolved Hide resolved
Makefile Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
docs/architecture.md Outdated Show resolved Hide resolved
@mateusoliveira43 mateusoliveira43 marked this pull request as ready for review April 16, 2024 19:41
README.md Outdated Show resolved Hide resolved
@weshayutin
Copy link
Contributor

Looks good enough for where we currently stand w/ OADP non-admin. Will update as necessary.
Thank you @mateusoliveira43

@weshayutin weshayutin merged commit 94c4be9 into migtools:master Apr 23, 2024
9 of 10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Merged / Ready for build
Development

Successfully merging this pull request may close these issues.

Integrate Non-Admin Controller with OADP
6 participants