Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve API reference docs #667

Merged
merged 1 commit into from
Nov 10, 2021

Commits on Nov 10, 2021

  1. Improve API reference docs

    This commit updates API documentation on the Go types and also improves
    the generated API documentation to include only the public types, as well
    as other minor small fixes for readability.
    
    Note that the `+gencopy` comments added to the API types are to work around
    an issue[1] in the upstream docs generation code which doesn't yet understand
    the `+kubebuilder:object:root` tag. This is necessary to make the generator
    understand which types are "public" (e.g. HostedCluster and NodePool).
    
    [1] ahmetb/gen-crd-api-reference-docs#26
    ironcladlou committed Nov 10, 2021
    Configuration menu
    Copy the full SHA
    32f870e View commit details
    Browse the repository at this point in the history