Skip to content

Chapter 5 update - #4625

Merged
liamfallon merged 5 commits into
kptdev:mainfrom
Nordix:chapter-5-update
Jul 13, 2026
Merged

liamfallon merged 5 commits into
kptdev:mainfrom
Nordix:chapter-5-update

Conversation

@OisinJohnston2005

Copy link
Copy Markdown
Contributor

Fixes issues with chapter 5 of the kpt book, some urls were outdated (stuff like moving from master branch to main) and the get-started repo's code is outdated in the current version

Copilot AI review requested due to automatic review settings July 8, 2026 09:13
@netlify

netlify Bot commented Jul 8, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for kptdocs ready!

Name Link
🔨 Latest commit 1c1b58b
🔍 Latest deploy log https://app.netlify.com/projects/kptdocs/deploys/6a54eb5699b4180008dcc962
😎 Deploy Preview https://deploy-preview-4625--kptdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@dosubot dosubot Bot added size:M This PR changes 30-99 lines, ignoring generated files. documentation Improvements or additions to documentation labels Jul 8, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates Chapter 5 of the kpt book to align the “developing functions” walkthrough with current upstream repositories/branches and the latest get-started scaffolding.

Changes:

  • Switches the kpt pkg get example from @master to @main.
  • Updates the embedded Go main.go example to include fn.WithDocs(...) and go:embed assets.
  • Adjusts testdata/example paths and a shell pipeline command used in the walkthrough.
Comments suppressed due to low confidence (1)

documentation/content/en/book/05-developing-functions/_index.md:248

  • The testdata instructions are inconsistent: the comment points to testdata/noop-passthrough/resources.yaml, but the edit command uses testdata/test1/resources.yaml, and the subsequent kpt fn source sources the whole testdata directory. This makes it unclear which resources are being tested.
# Edit the `testdata/noop-passthrough/resources.yaml` with your KRM resources. 
# resources.yaml already has a `Deployment` and `Service` as test data. 
vim testdata/test1/resources.yaml

# Convert the KRM resources and FunctionConfig resource to `ResourceList`, and 

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread documentation/content/en/book/05-developing-functions/_index.md
Comment thread documentation/content/en/book/05-developing-functions/_index.md
Comment thread documentation/content/en/book/05-developing-functions/_index.md
Comment thread documentation/content/en/book/05-developing-functions/_index.md Outdated
@liamfallon

Copy link
Copy Markdown
Contributor

Once the copilot comments are resolved we can go for a human review.

@efiacor

efiacor commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

rebase required

mozesl-nokia
mozesl-nokia previously approved these changes Jul 10, 2026
@dosubot dosubot Bot added the lgtm label Jul 10, 2026
Signed-off-by: Oisin Johnston 
@OisinJohnston2005
OisinJohnston2005 requested review from a team July 13, 2026 13:10
@dosubot dosubot Bot added size:S This PR changes 10-29 lines, ignoring generated files. and removed size:M This PR changes 30-99 lines, ignoring generated files. labels Jul 13, 2026
aravindtga
aravindtga previously approved these changes Jul 13, 2026
Comment thread documentation/content/en/book/05-developing-functions/_index.md Outdated
Co-authored-by: Aravindhan Ayyanathan 
Signed-off-by: Oisin Johnston 
@liamfallon
liamfallon merged commit 1365ca2 into kptdev:main Jul 13, 2026
25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation lgtm size:S This PR changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants