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

Add doc about Operator and CRD scope #3623

Open
camilamacedo86 opened this issue Sep 16, 2023 · 7 comments
Open

Add doc about Operator and CRD scope #3623

camilamacedo86 opened this issue Sep 16, 2023 · 7 comments
Assignees
@sarthaksarthak9
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature.

Comments

@camilamacedo86
Copy link
Member

What do you want to happen?

Context and Motivation

The Kubebuilder docs does not explain the Operator and CRD scope.
Therefore, we have questions like #3155

The goal of the task

The goal of this task is to create those documentations under reference.
See that is well documented in the Operator-SDK documentation:

We can use the content available there to create a documentation in Kubebulder but we should not link Operator-SDK docs.

How to do it:

  • Create a PR to add the doc under the section reference
  • Update either the summury
  • Verify your changes using the doc preview available when you push the PR

Extra Labels

/kind documentation
@camilamacedo86 camilamacedo86 added the kind/feature Categorizes issue or PR as related to a new feature. label Sep 16, 2023
@k8s-ci-robot k8s-ci-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Sep 16, 2023
@camilamacedo86 camilamacedo86 added the good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. label Sep 16, 2023
@lowang-bh

This comment was marked as outdated.

Sign in to view
@lowang-bh

This comment was marked as outdated.

Sign in to view
@camilamacedo86

This comment was marked as outdated.

Sign in to view
@rakshitgondwal

This comment was marked as outdated.

Sign in to view
@lowang-bh lowang-bh removed their assignment Jan 17, 2024
@lowang-bh

This comment was marked as outdated.

Sign in to view
@rakshitgondwal
Copy link
Member

Thank you for the update @lowang-bh
/assign

@sarthaksarthak9
Copy link
Contributor

/assign

@sarthaksarthak9 sarthaksarthak9 mentioned this issue Mar 3, 2024
Open
@rakshitgondwal rakshitgondwal removed their assignment Apr 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sarthaksarthak9 sarthaksarthak9

Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@camilamacedo86 @k8s-ci-robot @lowang-bh @rakshitgondwal @sarthaksarthak9