feat(main): add docs for automq operator #43
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request includes several updates to documentation and build scripts for the
automq-operatorproject. The most significant changes involve adding comprehensive contribution guidelines, updating the README with installation instructions, and modifying the Makefile to support image setting.Documentation Enhancements:
CONTRIBUTING.md: Added a detailed guide on contributing to theautomq-operatorproject, including sections on code and documentation contributions, workspace preparation, commit rules, and PR descriptions.README.md: Updated with new sections on project goals, description, prerequisites, installation instructions for dependencies and the operator, and verification steps.Build Script Updates:
Makefile: Added a newset-imagetarget to update the image in the Helm chart values file.README.md: Modified themake runcommand to includemake generatebeforemake manifestsfor generating API definitions.