docs: improve Build Service README with architecture and usage details#567
Open
nihar-landge wants to merge 2 commits intokonflux-ci:mainfrom
Open
docs: improve Build Service README with architecture and usage details#567nihar-landge wants to merge 2 commits intokonflux-ci:mainfrom
nihar-landge wants to merge 2 commits intokonflux-ci:mainfrom
Conversation
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
Author
|
Hey @MartinBasti @StanislavJochman 👋 I've opened this PR to improve the Build Service README with better |
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
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 was missing key information and had some inaccuracies that could confuse new contributors and operators. This PR improves clarity, accuracy, and completeness.
Changes made
kubectlcommands using kubebuilder-standard deployment selectorsplatform-dependentrather than claiming it must be separately installed)make runfor local testing without deploying to clusterTesting
Documentation-only change. No code was modified.
Fixes #544