Generate CLI Documentation from Go code - Githubissues

nginxinc / nginx-service-mesh

A service mesh powered by NGINX Plus to manage container traffic in Kubernetes environments.

https://docs.nginx.com/nginx-service-mesh

Apache License 2.0

93 stars 30 forks source link

Generate CLI Documentation from Go code #294

Open keagarwal opened 1 year ago

keagarwal commented 1 year ago

Proposed changes

Added auto-generation for CLI documentation from Go code. A new command has been added to the make generate rule which autogenerates the documentation.
You can also run go run -ldflags '-X main.genDocs=true' cmd/nginx-meshctl/main.go > /dev/null to just generate the documentation.
Removed UsageTemplates from top.go and upgrade.go since they were printing out some flags redundantly.

Checklist

Before creating a PR, run through this checklist and mark each as complete.

[x] I have read the CONTRIBUTING doc
[ ] I have added tests that prove my fix is effective or that my feature works
[x] I have checked that all unit tests pass after adding my changes
[x] I have updated necessary documentation
[x] I have rebased my branch onto main
[x] I will ensure my PR is targeting the main branch and pulling from my branch from my own fork