docs: Restructure DEVELOPMENT.md for developer-first workflow - #3805
docs: Restructure DEVELOPMENT.md for developer-first workflow#3805TheDevCodingKen wants to merge 4 commits into
Conversation
Restructures the development guide to prioritize the local 'kind' development loop as the primary path for new contributors. Moves the heavy cloud infrastructure (GKE/OpenShift) setups to an advanced section and removes outdated Kubernetes version flags.
tekton-robot
added
the
release-note
|
|
tekton-robot
added
the
size/L
There was a problem hiding this comment.
Pull request overview
This PR restructures DEVELOPMENT.md to lead with a local kind-based workflow for faster contributor onboarding, and moves cloud-provider setup guidance (e.g., GKE) into an “Advanced” section to keep the default path lightweight.
Changes:
- Reorganizes the guide around a recommended local
kinddevelopment loop (make dev-setup, build/apply, iterate). - Moves GKE setup into an “Cloud Environments (Advanced)” section and updates the GKE guidance to avoid the previously broken external link (Issue #1914 context).
- Simplifies and refreshes the “Additional Resources” section for new contributors.
Comments suppressed due to low confidence (12)
DEVELOPMENT.md:42
- This code block contains shell commands but is labeled as
go, which results in incorrect syntax highlighting.
```go
DEVELOPMENT.md:166
- This code block contains shell commands but is labeled as
go, which results in incorrect syntax highlighting.
```go
DEVELOPMENT.md:179
- This code block contains shell commands but is labeled as
go, which results in incorrect syntax highlighting.
```go
DEVELOPMENT.md:73
- This code block contains a
makecommand but is labeled asgo, which results in incorrect syntax highlighting.
```go
DEVELOPMENT.md:79
- This code block contains a
makecommand but is labeled asgo, which results in incorrect syntax highlighting.
```go
DEVELOPMENT.md:97
- This code block contains a
makecommand but is labeled asgo, which results in incorrect syntax highlighting.
```go
DEVELOPMENT.md:103
- This code block contains a
makecommand but is labeled asgo, which results in incorrect syntax highlighting.
```go
DEVELOPMENT.md:109
- This code block contains a
makecommand but is labeled asgo, which results in incorrect syntax highlighting.
```go
DEVELOPMENT.md:115
- This code block contains a
makecommand but is labeled asgo, which results in incorrect syntax highlighting.
```go
DEVELOPMENT.md:125
- This code block contains a
makecommand but is labeled asgo, which results in incorrect syntax highlighting.
```go
DEVELOPMENT.md:131
- This code block contains a
makecommand but is labeled asgo, which results in incorrect syntax highlighting.
```go
DEVELOPMENT.md:201
- This code block contains shell commands but is labeled as
go, which results in incorrect syntax highlighting.
```go
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
|
/assign @anithapriyanatarajan |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3805 +/- ##
==========================================
+ Coverage 25.47% 26.70% +1.22%
==========================================
Files 449 465 +16
Lines 23363 25010 +1647
==========================================
+ Hits 5952 6679 +727
- Misses 16725 17601 +876
- Partials 686 730 +44
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
@TheDevCodingKen - could you allow maintainer edit for this PR. Also would appreciate if you could remove that screenshot from PR description and include the slack link. Thank you |
No problem at all, @anithapriyanatarajan. I've made these changes. |
/assign @pratap0007 |
Finish the DEVELOPMENT.md restructure so a new contributor can reach a running operator within the first screenful, and remove content that has rotted for lack of an owner or CI. What changed: - Reorganise into a single kind-first path: Before you start, Quick start with kind (with verification commands), the development loop, Testing, Code generation, Developing for OpenShift, Other clusters, Troubleshooting, Contributing and Additional resources. - Add Testing and Troubleshooting sections. The PR template asks for `make test lint` but the guide never explained how, and common local setup failures had nowhere to live. - Remove the GKE walkthrough. It referenced Kubernetes 1.11 and gcloud flags that GKE has since removed, and produced the broken link in issue tektoncd#1914. Replace with a short "Other clusters" pointer that states the minimum Kubernetes version (1.28, from the README matrix) and cluster-admin requirement, and links to each provider's own docs. Detailed cloud walkthroughs belong on tekton.dev as dated blog posts. - Remove the `dep` / "Install dep v0.5.0" references (the repo uses Go modules with a vendored tree) and the $GOPATH/src clone requirement, keeping the fork-and-upstream-remote setup. - Replace the "Install Operator" and "Accessing logs" placeholders with real commands verified against the Makefile. - Convert the shell/make code fences Copilot flagged to `bash`. Every documented command was verified against the Makefile and hack/ scripts before inclusion. Signed-off-by: Anitha Natarajan <anataraj@redhat.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: 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 |
tekton-robot
added
release-note-none
|
@TheDevCodingKen, Thank you for following up on this PR. I pushed a commit on top of your branch (cadbbb15c) to align the guide to a kind-first structure. Your 3 commits are untouched. The new commit reorders to: Before you start → Quick start with kind → Development loop → Testing → Code generation → OpenShift → Other clusters → Troubleshooting. Reworded the cloud section: provider walkthroughs are called out as planned blog posts on tekton.dev (still to be written), not existing docs. Please pull the branch and give it a review when you get a chance. If you're happy with it, feel free to squash the whole thing into a single commit under your name, then we can get it merged. One caveat to flag: On my machine cc: @pratap0007 @jkhelil |
anithapriyanatarajan
added
the
do-not-merge/work-in-progress
Restructures the development guide to prioritize the local 'kind' development loop as the primary path for new contributors. Moves the heavy cloud infrastructure (GKE/OpenShift) setups to an advanced section and removes outdated Kubernetes version flags.
Context
Relevant conversation thread in the operator channel of Tekton Slack
Changes
Fixes #1914
Submitter Checklist
These are the criteria that every PR should meet, please check them off as you
review them:
make test lintbefore submitting a PRSee the contribution guide for more details.
Release Notes