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

[Docs] Revamp the documentation, install files, and examples #1003

Merged
merged 3 commits into from
Sep 19, 2024

Conversation

MikeEdgar
Copy link
Member

@MikeEdgar MikeEdgar commented Aug 28, 2024

  • Refactor the installation resource files and examples
  • Update README with instructions for operator install and example usage

@MikeEdgar MikeEdgar added the documentation Improvements or additions to documentation label Aug 28, 2024
@MikeEdgar MikeEdgar force-pushed the doc-revamp branch 5 times, most recently from fa0781b to 351eb30 Compare September 4, 2024 14:03
@MikeEdgar MikeEdgar force-pushed the doc-revamp branch 2 times, most recently from ca88519 to b8b7bc0 Compare September 6, 2024 13:43
Copy link
Contributor

@PaulRMellor PaulRMellor left a comment

Choose a reason for hiding this comment

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

Looks good, @MikeEdgar
Readme is clear. I left a few suggestions

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
@MikeEdgar MikeEdgar force-pushed the doc-revamp branch 2 times, most recently from 0a59f64 to f3755ac Compare September 9, 2024 18:35
@MikeEdgar MikeEdgar force-pushed the doc-revamp branch 3 times, most recently from 09b9770 to c6f399a Compare September 18, 2024 17:26
@MikeEdgar MikeEdgar marked this pull request as ready for review September 18, 2024 17:29
Copy link

sonarcloud bot commented Sep 19, 2024

@MikeEdgar MikeEdgar merged commit b69c41d into main Sep 19, 2024
9 checks passed
@MikeEdgar MikeEdgar deleted the doc-revamp branch September 19, 2024 11:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants