doc feedback

[jotak]

@skrthomas FYI
cc @memodi @nathan-weinberg

[jotak]

(For info it's not needed to backport this PR, it can be merged just in main)

[skrthomas]

Thanks for making these updates Joel. I'm glad it doesn't need to be backported 😅 lgtm!

[skrthomas]

Edit: It seems like no one is sure and some people are saying they don't get PM approval for GitHub links in autogenerated APIs so, I guess to heck with the contributing guidelines warning against it 😆 just keep the GitHub link. Sorry for worrying you. I think I've had too many sweaty discussions with Eric Rich about including GitHub links 😅

Second edit: with Slack consensus from interested parties on the docs team, I'm opening a PR to modify our contributing guidelines to make an exception for github links in autogenerated API docs: openshift/openshift-docs#71592

For the GitHub link: openshift/openshift-docs#71033 (comment), since the style of product docs doesn't really play nicely for the upstream documentation, I can amend the link in the product doc version only. Otherwise, I'm double checking with the docs team about this issue. I feel its a really good example for why we need to be able to put links in modules. It sucks because we literally have this same reference replicated in product docs but we can't create a proper link :(

[jotak]

/retest

[jotak]

@skrthomas thanks!
I added @nathan-weinberg 's suggestion about "use at your own risk", so I think we're good now

[openshift-ci]

@jotak: The following test 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/e2e-operator	d916f8c	link	false	/test e2e-operator

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.

[nathan-weinberg]

LGTM!

[jotak]

/approve

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jotak

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

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