Skip to content

distinguish CRD vs built-in pointer guidance in api-conventions#8990

Open
omerap12 wants to merge 3 commits into
kubernetes:mainfrom
omerap12:update-api-convention
Open

distinguish CRD vs built-in pointer guidance in api-conventions#8990
omerap12 wants to merge 3 commits into
kubernetes:mainfrom
omerap12:update-api-convention

Conversation

@omerap12
Copy link
Copy Markdown
Member

@omerap12 omerap12 commented May 18, 2026

Which issue(s) this PR fixes:

Fixes #

Just finished reading this doc. I found this diagram much more informative than the current one.

/cc @soltysh

Signed-off-by: Omer Aplatony <omerap12@gmail.com>
@k8s-ci-robot k8s-ci-robot requested a review from soltysh May 18, 2026 06:28
@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label May 18, 2026
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: omerap12
Once this PR has been reviewed and has the lgtm label, please assign dims for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found 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 area/developer-guide Issues or PRs related to the developer guide sig/architecture Categorizes an issue or PR as relevant to SIG Architecture. sig/contributor-experience Categorizes an issue or PR as relevant to SIG Contributor Experience. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels May 18, 2026
K -- Yes --> O[Need to distinguish <br/> Unset from Empty?];

O -- Yes --> P["USE: Pointer to slice/map <br/> (*[]T or *map[K]V)"];
O -- No --> J;
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.

Overall, this looks good, although I wonder if splitting this diagram into separate will make it easier to read. First for the built-ins, then for CRDs. Smaller diagrams are easier to read and comprehend.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I will make another commit that seperates those two and we can see if it makes it easier to understand.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Pushed a commit ea69e7a

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.

Nit: but can we make the built-in first?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

done

omerap12 added 2 commits May 25, 2026 06:37
Signed-off-by: Omer Aplatony <omerap12@gmail.com>
Signed-off-by: Omer Aplatony <omerap12@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/developer-guide Issues or PRs related to the developer guide cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. sig/architecture Categorizes an issue or PR as relevant to SIG Architecture. sig/contributor-experience Categorizes an issue or PR as relevant to SIG Contributor Experience. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants