Skip to content

Comments

docs: improve Build Service README with architecture and usage details#567

Open
nihar-landge wants to merge 2 commits intokonflux-ci:mainfrom
nihar-landge:docs/build-service-readme
Open

docs: improve Build Service README with architecture and usage details#567
nihar-landge wants to merge 2 commits intokonflux-ci:mainfrom
nihar-landge:docs/build-service-readme

Conversation

@nihar-landge
Copy link

@nihar-landge nihar-landge commented Feb 20, 2026

Summary

The existing README was missing key information and had some inaccuracies that could confuse new contributors and operators. This PR improves clarity, accuracy, and completeness.

Changes made

  • Added Table of Contents and section dividers for easier navigation
  • Split installation instructions into Production vs Development/Standalone sections
  • Added Verifying the Installation section with accurate kubectl commands using kubebuilder-standard deployment selectors
  • Converted operating modes and PipelineRun parameters to tables for readability
  • Clarified default controller behavior when no annotation is set on a Component CR
  • Softened Renovate dependency wording to be platform-neutral (platform-dependent rather than claiming it must be separately installed)
  • Removed Renovate from the Dependencies table to avoid inaccurate framing
  • Removed hardcoded pipeline count ("five pipelines") to prevent docs going stale across releases
  • Added make run for local testing without deploying to cluster
  • Expanded Contributing section with dev commands and code of conduct link

Testing

Documentation-only change. No code was modified.

Fixes #544

@nihar-landge nihar-landge requested a review from a team as a code owner February 20, 2026 08:51
@snyk-io
Copy link

snyk-io bot commented Feb 20, 2026

Snyk checks have passed. No issues have been found so far.

Status Scanner Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues
Licenses 0 0 0 0 0 issues
Code Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@nihar-landge
Copy link
Author

Hey @MartinBasti @StanislavJochman 👋

I've opened this PR to improve the Build Service README with better
structure, accurate verification commands, and clearer architecture
details. Would appreciate a review when you get a chance!

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.

Add Documentation for Build Service

1 participant