[WIP] Update API doc comments and template

[abrennan89]

Description

Testing changes to make the API docs more compatible with the OCP product docs to reduce manual work required by writers.

/hold

/cc /assign

/cherry-pick

Links

• Depending on PR(s):
• Bugzilla:
• Github issue:
• JIRA:
• Enhancement proposal:

[openshift-ci[bot]]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: abrennan89 Once this PR has been reviewed and has the lgtm label, please assign periklis for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

• OWNERS

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

[openshift-ci[bot]]

@abrennan89: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
ci/prow/functional-target	17b3d1660238d8f7db272d3ba1cd02fbe4f8cc77	link	true	/test functional-target
ci/prow/functional	17b3d1660238d8f7db272d3ba1cd02fbe4f8cc77	link	false	/test functional
ci/prow/e2e-target	17b3d1660238d8f7db272d3ba1cd02fbe4f8cc77	link	true	/test e2e-target
ci/prow/e2e-ocp-target-minus-one	17b3d1660238d8f7db272d3ba1cd02fbe4f8cc77	link	false	/test e2e-ocp-target-minus-one

Full PR test history. Your PR dashboard.

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. I understand the commands that are listed here.