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

feat(docs): improve docs with examples #31

Merged
merged 5 commits into from
Dec 5, 2023
Merged

feat(docs): improve docs with examples #31

merged 5 commits into from
Dec 5, 2023

Conversation

rafalgalaw
Copy link
Collaborator

@rafalgalaw rafalgalaw commented Dec 4, 2023

  • Add overview image to improve understanding on how garm-operator fits into garm landscape
  • provide examples for better understanding on how to use / interact with operator

@rafalgalaw rafalgalaw changed the title feat(docs): add overview.png feat(docs): improve docs with examples Dec 4, 2023
@rafalgalaw rafalgalaw self-assigned this Dec 4, 2023
@rafalgalaw rafalgalaw linked an issue Dec 4, 2023 that may be closed by this pull request
Copy link
Member

@bavarianbidi bavarianbidi left a comment

Choose a reason for hiding this comment

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

just few nits - but in general LGTM

README.md Show resolved Hide resolved
docs/readme.md Outdated Show resolved Hide resolved
docs/readme.md Outdated Show resolved Hide resolved
docs/readme.md Outdated Show resolved Hide resolved
@rafalgalaw rafalgalaw merged commit 036999a into main Dec 5, 2023
2 checks passed
@rafalgalaw rafalgalaw deleted the feat/docs branch December 5, 2023 10:14
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.

Usage of garm-operator is not quite clear
2 participants