add doc gen template and update doc for Ingress #307
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add doc gen template & update doc for Ingress
Note, the doc gen tool don't support kubebuilder v2.
You need to
// +genclient
to type declarations with a blank line before other comments.gen-crd-api-reference-docs -template-dir=/Users/yyyng/workplace/AppMesh/aws-app-mesh-controller-for-k8s/hack/api-docs/template/ -config=/Users/yyyng/workplace/AppMesh/aws-app-mesh-controller-for-k8s/hack/api-docs/config.json -api-dir=github.com/aws/aws-app-mesh-controller-for-k8s/apis/appmesh/v1beta2 -out-file docs/reference/api_spec.md
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.