Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Link to API reference for ServiceAccount #45747

Closed
sftim opened this issue Apr 1, 2024 · 3 comments · Fixed by #45750
Closed

Link to API reference for ServiceAccount #45747

sftim opened this issue Apr 1, 2024 · 3 comments · Fixed by #45750
Assignees
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/feature Categorizes issue or PR as related to a new feature. language/en Issues or PRs related to English language triage/accepted Indicates an issue or PR is ready to be actively worked on. wg/api-expression Categorizes an issue or PR as relevant to WG API Expression.

Comments

@sftim
Copy link
Contributor

sftim commented Apr 1, 2024

This is a Feature Request

What would you like to be added
Update the front matter for https://kubernetes.io/docs/concepts/security/service-accounts/ to link to the API reference for that page.

You can find the API group and kind for ServiceAccount if you start from https://kubernetes.io/docs/concepts/security/service-accounts/#what-s-next, and you can look at #45746 to see a PR that does a similar thing for NetworkPolicy. Note that ServiceAccount is in the core API group so the API group string won't contain a / (unlike NetworkPolicy).

If you're not sure what the change should look like, visit https://github.com/kubernetes/website/pull/45746/files

Why is this needed
This change helps readers find the API reference documentation quickly.

Comments
/language en
/wg api-expression
/help

@sftim sftim added the kind/feature Categorizes issue or PR as related to a new feature. label Apr 1, 2024
@k8s-ci-robot
Copy link
Contributor

@sftim:
This request has been marked as needing help from a contributor.

Guidelines

Please ensure that the issue body includes answers to the following questions:

  • Why are we solving this issue?
  • To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
  • Does this issue have zero to low barrier of entry?
  • How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help command.

In response to this:

This is a Feature Request

What would you like to be added
Update the front matter for https://kubernetes.io/docs/concepts/security/service-accounts/ to link to the API reference for that page.

You can find the API group and kind for ServiceAccount if you start from https://kubernetes.io/docs/concepts/security/service-accounts/#what-s-next, and you can look at #45746 to see a PR that does a similar thing for NetworkPolicy. Note that ServiceAccount is in the core API group so the API group string won't contain a / (unlike NetworkPolicy).

If you're not sure what the change should look like, visit https://github.com/kubernetes/website/pull/45746/files

Why is this needed
This change helps readers find the API reference documentation quickly.

Comments
/language en
/wg api-expression
/help

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. wg/api-expression Categorizes an issue or PR as relevant to WG API Expression. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Apr 1, 2024
@dev-johnn
Copy link
Contributor

I can try to help with this.

/assign

@dipesh-rawat
Copy link
Member

/triage accepted

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Apr 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/feature Categorizes issue or PR as related to a new feature. language/en Issues or PRs related to English language triage/accepted Indicates an issue or PR is ready to be actively worked on. wg/api-expression Categorizes an issue or PR as relevant to WG API Expression.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants