Add comprehensive README with quickstart and examples#63
Open
rhuss wants to merge 1 commit into
Open
Conversation
The existing README contained only a one-line description and badges. This adds: - How it works: step-by-step sync pipeline explanation with diagram - Installation: from releases and from source - Quickstart: end-to-end guide from repo setup to first sync - Configuration reference: all fields with types, defaults, descriptions - File filters and carried patches documentation - Examples: minimal config, Knative-style, custom release naming, CI automation - Architecture overview of the package layout - Development instructions Assisted-By: 🤖 Claude Code
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: rhuss The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
This file contains hidden or 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
1 participant
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.
Summary
The existing README contains only a one-line description and status badges. This PR adds comprehensive documentation covering:
openshift/patches/Motivation
Deviate solves a real problem (automated upstream-to-downstream sync with patch management), but the lack of documentation makes it hard for new adopters to discover and use. We're evaluating deviate for the kagenti midstream sync pipeline and found the code well-structured but undocumented.
All content was derived from reading the source code (config structures, sync pipeline, CLI flags, test fixtures).
Test plan
pkg/config/structure.go