docs: Restructure DEVELOPMENT.md for developer-first workflow - #3805
docs: Restructure DEVELOPMENT.md for developer-first workflow#3805TheDevCodingKen wants to merge 3 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
|
[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
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% 25.40% -0.08%
==========================================
Files 449 449
Lines 23363 23477 +114
==========================================
+ Hits 5952 5964 +12
- Misses 16725 16822 +97
- Partials 686 691 +5
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 |
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