Skip to content

Clarify path annotation semantics and link to metadata schema reference - #4666

Open
aravindtga wants to merge 3 commits into
kptdev:mainfrom
Nordix:link-metadata-schema
Open

Clarify path annotation semantics and link to metadata schema reference#4666
aravindtga wants to merge 3 commits into
kptdev:mainfrom
Nordix:link-metadata-schema

Conversation

@aravindtga

@aravindtga aravindtga commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Description

  • What changed:
    • Added path annotation details section to the annotations reference page explaining that the path is relative to the package directory containing the Kptfile whose pipeline invoked the function.
    • Added cross-reference from the Functions Specification section in book chapter 5 to the annotations reference.
    • Added link to the catalog's metadata schema documentation in the "Next Steps" section of book chapter 5.
  • Why it's needed: The path annotation semantics were only documented in code comments, not in user-facing docs. Function authors had no guidance on what "relative to that directory" means in the functions spec.
  • How it works: Expands the annotations reference and adds cross-references from the developing functions chapter.

Related Issue(s)

Type of Change

  • Documentation

Checklist

  • Code follows project style guidelines
  • Self-reviewed changes
  • Tests added/updated
  • Documentation added/updated
  • All tests and gating checks pass

AI Disclosure

  • I have used AI in the creation of this PR.

Signed-off-by: Aravindhan Ayyanathan <aravindhan.a@est.tech>
@aravindtga aravindtga self-assigned this Jul 27, 2026
@netlify

netlify Bot commented Jul 27, 2026

Copy link
Copy Markdown

Deploy Preview for kptdocs ready!

Name Link
🔨 Latest commit bff76c2
🔍 Latest deploy log https://app.netlify.com/projects/kptdocs/deploys/6a68c16388d0c90008393224
😎 Deploy Preview https://deploy-preview-4666--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.

@aravindtga
aravindtga marked this pull request as ready for review July 27, 2026 14:02
@aravindtga
aravindtga requested review from a team July 27, 2026 14:02
@dosubot dosubot Bot added size:XS This PR changes 0-9 lines, ignoring generated files. documentation Improvements or additions to documentation labels Jul 27, 2026
Signed-off-by: Aravindhan Ayyanathan <aravindhan.a@est.tech>
@dosubot dosubot Bot added size:S This PR changes 10-29 lines, ignoring generated files. and removed size:XS This PR changes 0-9 lines, ignoring generated files. labels Jul 27, 2026
@aravindtga aravindtga changed the title Link to metadata.yaml schema reference from developing functions guide Clarify path annotation semantics and link to metadata schema reference Jul 27, 2026
@dosubot dosubot Bot added the lgtm label Jul 27, 2026
@aravindtga
aravindtga requested a review from a team July 27, 2026 15:51
@liamfallon
liamfallon requested a review from Copilot July 28, 2026 14:25

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

Note

Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.

Documents the semantics of the internal.config.kubernetes.io/path annotation and adds cross-references in the “Developing functions” chapter, including a link to the catalog metadata schema.

Changes:

  • Added a dedicated “Path annotation details” section to the annotations reference.
  • Added a cross-reference from Book Ch. 5 (Functions Specification) to the annotations reference.
  • Added a “Next Steps” link to the catalog metadata.yaml schema documentation.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
documentation/content/en/reference/annotations/_index.md Adds user-facing documentation clarifying how internal.config.kubernetes.io/path is interpreted.
documentation/content/en/book/05-developing-functions/_index.md Adds cross-reference to the new annotation docs and links to the catalog metadata schema reference.

💡 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 Outdated
Comment thread documentation/content/en/reference/annotations/_index.md Outdated
Signed-off-by: Aravindhan Ayyanathan <aravindhan.a@est.tech>
@sonarqubecloud

Copy link
Copy Markdown

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.

Function spec docs needs to clarify the path annotation details Document the schema for function's metadata.yaml

3 participants