Fixing API Reference Doc Generation

[robscott]

What type of PR is this?
/kind cleanup

What this PR does / why we need it:
Previously reference docs were converted from godoc to HTML with gen-crd-api-reference-docs and then converted to markdown with mkdocs as part of generating the docs site. This takes out the second step and instead inserts the generated html for the reference docs directly into the generated html for the docs site.

I will be the first to say this is a rather ugly solution and I'm very open to others. I've tried lots of different approaches but it's quite difficult to solve this without removing the double conversion that was happening before. I tried using the include directive we use elsewhere with mkdocs but even that results in the html getting converted to markdown again. #539 has some other options I tried as well with limited success.

Some notable downsides of this approach:

• We need to use backticks to escape * characters in godoc.
• Generated reference docs are not included in make serve.
• docs-src/spec.md does not include generated reference docs - need to either look at docs-src/spec.html or the website itself.

I'm very open to other solutions here, but so far this is the least bad solution I've found.

Which issue(s) this PR fixes:
Fixes #539

Does this PR introduce a user-facing change?:

NONE

/cc @jpeach @hbagdi @jberger

[k8s-ci-robot]

@robscott: GitHub didn't allow me to request PR reviews from the following users: jberger.

Note that only kubernetes-sigs members and repo collaborators can review this PR, and authors cannot review their own PRs.

In response to this:

What type of PR is this?
/kind cleanup

What this PR does / why we need it:
Previously reference docs were converted from godoc to HTML with gen-crd-api-reference-docs and then converted to markdown with mkdocs as part of generating the docs site. This takes out the second step and instead inserts the generated html for the reference docs directly into the generated html for the docs site.

I will be the first to say this is a rather ugly solution and I'm very open to others. I've tried lots of different approaches but it's quite difficult to solve this without removing the double conversion that was happening before. I tried using the include directive we use elsewhere with mkdocs but even that results in the html getting converted to markdown again. #539 has some other options I tried as well with limited success.

Some notable downsides of this approach:

• We need to use backticks to escape * characters in godoc.
• Generated reference docs are not included in make serve.
• docs-src/spec.md does not include generated reference docs - need to either look at docs-src/spec.html or the website itself.

I'm very open to other solutions here, but so far this is the least bad solution I've found.

Which issue(s) this PR fixes:
Fixes #539

Does this PR introduce a user-facing change?:

NONE

/cc @jpeach @hbagdi @jberger

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.

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: robscott

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 [robscott]

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

[robscott]

Need to get tests running again now that repo has been renamed, will make a PR to test-infra shortly.
/hold

[robscott]

Waiting for kubernetes/test-infra#20851 to merge in before cancelling hold on this.

[robscott]

/retest

[bowei]

seems ok to me

/lgtm

[robscott]

@bowei Updated to use better replacement string. PTAL.

/hold cancel

[youngnick]

I agree it's not the most elegant solution, but it's much, much better than what we had before.

/lgtm