Skip to content

Conversation

@ivankatliarchuk
Copy link
Member

@ivankatliarchuk ivankatliarchuk commented Jan 1, 2026

What does it do ?

Go doc style added to sources. So that it should be easier to keep documentation in sync

Follow-up:

  • add annotations support, aka which source supports which annotations

follow-up

Motivation

Documentation in sync with code. This should simplify identifying which sources supports what functionality.

More

  • Yes, this PR title follows Conventional Commits
  • Yes, I added unit tests
  • Yes, I updated end user documentation accordingly

@k8s-ci-robot k8s-ci-robot requested review from szuecs and vflaux January 1, 2026 14:54
@k8s-ci-robot k8s-ci-robot added internal Issues or PRs related to internal code source cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jan 1, 2026
@coveralls
Copy link

coveralls commented Jan 1, 2026

Pull Request Test Coverage Report for Build 20698076285

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 540 unchanged lines in 20 files lost coverage.
  • Overall coverage increased (+0.02%) to 78.818%

Files with Coverage Reduction New Missed Lines %
empty.go 2 75.0%
fake.go 2 96.23%
connector.go 3 80.0%
pod.go 9 95.14%
node.go 10 92.37%
istio_gateway.go 16 89.2%
f5_transportserver.go 17 77.42%
f5_virtualserver.go 19 79.21%
openshift_route.go 20 85.0%
ingress.go 21 88.6%
Totals Coverage Status
Change from base Build 20636734136: 0.02%
Covered Lines: 15922
Relevant Lines: 20201

💛 - Coveralls

@ivankatliarchuk ivankatliarchuk marked this pull request as draft January 1, 2026 15:06
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jan 1, 2026
@k8s-ci-robot k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jan 1, 2026
@ivankatliarchuk ivankatliarchuk marked this pull request as ready for review January 1, 2026 17:46
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jan 1, 2026
@ivankatliarchuk ivankatliarchuk changed the title docs(source): autogenerate docs from sources attached to annotations docs(source): autogenerate docs for sources with go-doc like style Jan 1, 2026
Copy link
Contributor

@vflaux vflaux left a comment

Choose a reason for hiding this comment

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

Great addition to the doc imo.
(XXL PR => XXL Review 😄)

ivankatliarchuk and others added 17 commits January 4, 2026 18:08
@ivankatliarchuk ivankatliarchuk requested a review from vflaux January 5, 2026 08:00
Copy link
Contributor

@vflaux vflaux left a comment

Choose a reason for hiding this comment

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

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 5, 2026
@ivankatliarchuk
Copy link
Member Author

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ivankatliarchuk

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 6, 2026
@k8s-ci-robot k8s-ci-robot merged commit 97af77f into kubernetes-sigs:master Jan 6, 2026
18 checks passed
@ivankatliarchuk ivankatliarchuk deleted the chore-source-docs branch January 6, 2026 22:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. docs internal Issues or PRs related to internal code lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. source

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants