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

Rewrite FAR README with more Sections #80

Merged
merged 7 commits into from
Feb 8, 2024

Conversation

razo7
Copy link
Member

@razo7 razo7 commented Aug 23, 2023

Rewrite the FAR readme with its latest changes and include new sections for further understanding:

  • Background on Fence agents, advantages of FAR, how FAR works, and its workflow.
  • FenceAgentsRemediation CR Status and the Remediation Events.
  • Installation and Usage update
  • Tests and Troubleshooting

@razo7 razo7 changed the title [WIP] Update FAR README for V0.2.0 Update FAR README for V0.2.0 Sep 19, 2023
@razo7 razo7 changed the title Update FAR README for V0.2.0 [WIP] Update FAR README for V0.2.0 Nov 19, 2023
@razo7 razo7 changed the title [WIP] Update FAR README for V0.2.0 Update FAR README for V0.3.0 Jan 31, 2024
Add v0.3.0 changes, explaing about fende agents, how FAR works, and workflow.
FAR CR has three condition status and remediation events that can help a user to understand how FAR works and its process
Add Kubernetes community installation, update fartemplate, links and etc.
Incldue troubleshooting steps and usage of FAR E2E on AWS
@razo7 razo7 changed the title Update FAR README for V0.3.0 Rewrite FAR README with more Sections Feb 1, 2024
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@clobrano clobrano left a comment

Choose a reason for hiding this comment

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

It seems to me that some concept are repeated too much (use with NHC, for example)

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Addressing Carlo's comments, and improve recommendation sentences reagrding FAR usage with other operators and fartemplate and alone
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Management interface was complicated to understand and node was repeated too much in one sentence. Also fix typos
@openshift-ci openshift-ci bot added the lgtm label Feb 8, 2024
Copy link
Contributor

openshift-ci bot commented Feb 8, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: clobrano, razo7

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-merge-bot openshift-merge-bot bot merged commit 8402a51 into medik8s:main Feb 8, 2024
10 checks passed
@razo7
Copy link
Member Author

razo7 commented Feb 8, 2024

/cherry-pick release-0.3

@openshift-cherrypick-robot

@razo7: new pull request created: #127

In response to this:

/cherry-pick release-0.3

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants