Add Developer Guide #163
Merged
Add Developer Guide #163
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This adds a developer guide that serves as an entrypoint for new code contributors. The operator project has existing documentation for local and OLM development, however it is buried in a nested directory that is not easy to find. Those documents also miss critical foundational knowledge, such as dev prerequisites and an understanding of OLM. The new guide includes links to the Operator SDK and kubebuilder tutorials, which will help contributors learn fundamentals like CRDs, controllers, and packaging operators with OLM. I have also included recommended tools when more than one choice is available in the market (ex: docker or podman for a container engine). Finally, I have tried to clarify when framework clis like `operator-sdk` and `kubebuilder` should be used, and when it is safe to "just code." Signed-off-by: Adam Kaplan <adam.kaplan@redhat.com>
pull-request-size
bot
added
the
size/M
openshift-ci
bot
added
the
kind/documentation
|
/approve |
openshift-ci
bot
added
the
approved
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: jkhelil, qu1queee The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
/lgtm |
|
@adambkaplan: you cannot LGTM your own PR. In response to this:
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. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
This adds a developer guide that serves as an entrypoint for new code contributors. The operator project has existing documentation for local and OLM development, however it is buried in a nested directory that is not easy to find. Those documents also miss critical foundational knowledge, such as dev prerequisites and an understanding of OLM.
This PR also fixes the broken link to the contributor guidelines.
/kind documentation
Submitter Checklist
See the contributor guide
for details on coding conventions, github and prow interactions, and the code review process.
Release Notes