Enhance in source documentation

[ArangoGutierrez]

This is a re-write of #67

Adding documentation to the code in 'main.go' so that contributors
and developers can understand the purpose of each function, variable,
etc..

Adding documentation to funcs and vars in nodefeaturediscovery_controller.go

Adding documentation to various functions and variables within the
nodefeaturediscovery_controller.go file so that users and contributors
can have a deeper understanding of how the reconciliation process
works with the NFD Operator.

Adding documentation for NFD controls functions

Adding documentation to describe what each of the vars and funcs in
the NFD controls file does, when to use them, and why they're
important.

Adding documentation to the NFD controller resources file

Adding documentation describing the funcs, vars, etc. in the NFD
controller resources file so that users and contributors can
understand how they all work.

Adding docs to NFD state funcs related to NFD itself (not just the operator)

Adding documentation to the NFD state functions related to NFD itself
so that users and contributors can understand how NFD works with the NFD
operator, especially if they are looking at another file that references
these functions and the NFD struct.

fix gofmt formatting

Signed-off-by: Courtney Pacheco cpacheco@redhat.com

Shorten controller and main.go documentation

The documentation in the controller and main.go files was
unnecessarily long and could pose problems in the future if a
maintainer or contributor wants to modify a feature that has a lot
of existing documentation. Ideally, documentation should be concise.

Update NFD documentation based on feedback

Update the NFD documentation based on feedback in the PR. Will
squash commits before merging.

[marquiz]

Change looks good 👍 The commit message looks horrible 🙀 😄

Could you tidy up the commit message. It think in this case even the subject alone (probably Enhance in-source documentation?), without any body would be enough.

[ArangoGutierrez]

@marquiz commit fixed

[marquiz]

Thanks @ArangoGutierrez, good to have this finally merged 👍
/lgtm

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ArangoGutierrez, marquiz

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:

• OWNERS [ArangoGutierrez,marquiz]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment