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

add doc gen template and update doc for Ingress #307

Merged
merged 2 commits into from
Jul 9, 2020

Conversation

M00nF1sh
Copy link
Contributor

@M00nF1sh M00nF1sh commented Jul 9, 2020

Add doc gen template & update doc for Ingress
Note, the doc gen tool don't support kubebuilder v2.
You need to

  1. create a doc.go with contents below
// Package v1beta2 contains API Schema definitions for the appmesh v1beta2 API group
// +kubebuilder:object:generate=true
// +groupName=appmesh.k8s.aws
package v1beta2
  1. add // +genclient to type declarations with a blank line before other comments.
  2. generate doc with 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.

@@ -0,0 +1,24 @@
Follow below instructions to generate docs

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

awesome!

Copy link

@fawadkhaliq fawadkhaliq left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@fawadkhaliq fawadkhaliq merged commit d7de227 into aws:master Jul 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants