Add DEVELOPER_GUIDE.md for new contributors#256
Conversation
Documents project architecture, CRDs, controller flows, external integrations, build targets, and local dev setup.
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces a detailed developer guide to centralize project knowledge and improve the onboarding experience for new contributors. It provides a comprehensive overview of the operator's architecture, API types, and operational workflows, serving as a single source of truth for development, testing, and deployment processes. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize the Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request introduces a comprehensive Developer Guide (DEVELOPER_GUIDE.md) for the Unstructured Data Controller, detailing its architecture, data models, business logic, external integrations, and development setup. The review feedback points out inconsistencies in the documented Go versions across different sections and an incorrect reference to a non-existent version of golangci-lint.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
|
|
||
| | Attribute | Value | | ||
| |-----------|-------| | ||
| | Language | Go 1.25+ | |
There was a problem hiding this comment.
There are several inconsistencies regarding the required Go version throughout the developer guide:
- Section 1 (line 37): Specifies
Go 1.25+ - Section 9 (line 691): Specifies
Go 1.25.0+ - Dev Container (line 737): Uses
Go 1.24(1-1.24-bookworm) - Section 10 (line 802): Mentions
ubi9/go-toolset:1.26(Go 1.26)
Please align these references to the actual minimum Go version required by the project (e.g., Go 1.24) to avoid confusion for new contributors.
| | kind | latest | Local Kubernetes cluster | | ||
| | kustomize | v5.6.0 | Manifest generation (auto-downloaded) | | ||
| | controller-gen | v0.18.0 | CRD/RBAC code generation (auto-downloaded) | | ||
| | golangci-lint | v2.10.0 | Linting (auto-downloaded) | |
There was a problem hiding this comment.
| kind: UnstructuredDataPipeline | ||
| metadata: | ||
| name: my-data-product | ||
| spec: |
There was a problem hiding this comment.
We might have to update this with the latest API changes
PuneetPunamiya
left a comment
There was a problem hiding this comment.
Wanted to understand the goal behind adding this readme
- Is it for just giving the complete understanding of the project
- Do we need to add steps for running the project as well (docling, localstack, etc)
|
|
||
| **Status condition type:** `VectorEmbeddingGenerationReady` | ||
|
|
||
| ### 4.6 SQSInformer |
There was a problem hiding this comment.
We do not have sqsInformer CRD now
Summary
Test plan