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.

Sign up for GitHub

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

Jump to bottom

Document API Specs in Reference section #5379

Open
annasong20 opened this issue Oct 12, 2023 · 6 comments
Open

Document API Specs in Reference section #5379

annasong20 opened this issue Oct 12, 2023 · 6 comments
Assignees
@ncapps
Labels
kind/documentation Categorizes issue or PR as related to documentation. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@annasong20
Copy link
Contributor

The Reference/API section of the new Kustomize site should include should contain a specification for each of the Kubernetes objects that Kustomize uses. Examples of Kustomize Kubernetes objects include those of kind

  • Kustomization
  • AnnotationsTransformer

A specification for a Kubernetes objects lists and briefly describes all fields in the object, including whether they're optional. Use the Kubernetes site as general guidance and #5247 as an example within the repo.
@k8s-ci-robot k8s-ci-robot added needs-kind Indicates a PR lacks a `kind/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Oct 12, 2023
@annasong20 annasong20 mentioned this issue Oct 12, 2023
Merged
@annasong20
Copy link
Contributor Author

/kind documentation

@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. and removed needs-kind Indicates a PR lacks a `kind/foo` label and requires one. labels Oct 12, 2023
@annasong20
Copy link
Contributor Author

/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 Oct 30, 2023
@professorabhay
Copy link

Hey @annasong20, Can I work on this?

@annasong20
Copy link
Contributor Author

@ncapps are you already working on this issue?

@ncapps ncapps mentioned this issue Dec 13, 2023
Merged
@ncapps
Copy link
Contributor

ncapps commented Dec 13, 2023

Hi, I was not aware of this issue. I have been working on this in relation to #5353.

#5447 is ready for approval and sets up some reusable short codes that will be helpful for follow-up PRs.

@ncapps
Copy link
Contributor

ncapps commented Dec 13, 2023

/assign ncapps

@ncapps ncapps mentioned this issue Jan 12, 2024
Merged
@ncapps ncapps mentioned this issue Jan 31, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ncapps ncapps

Labels
kind/documentation Categorizes issue or PR as related to documentation. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
Kustomize Documentation
Status: In Progress
Milestone
No milestone
Development

No branches or pull requests
4 participants
@ncapps @k8s-ci-robot @annasong20 @professorabhay