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

maintain: cli docgen fixes to clean up the resulting file #3431

Merged
merged 2 commits into from
Oct 12, 2022

Conversation

technovangelist
Copy link
Contributor

Signed-off-by: Matt Williams m@technovangelist.com

Summary

The docgen process was generating cli-reference.md, but all the docs point to cli.md after renaming a month or so back. So this update generates the right doc, and cleans up the generated doc a bit.

Checklist

  • Wrote appropriate unit tests
  • Considered security implications of the change
  • Updated associated docs where necessary
  • Updated associated configuration where necessary
  • Change is backwards compatible if it needs to be (user can upgrade without manual steps?)
  • Nothing sensitive logged
  • Considered data migrations for smooth upgrades

Related Issues

Resolves #

and point to the right cli.md file

Signed-off-by: Matt Williams <m@technovangelist.com>
@vercel vercel bot temporarily deployed to Preview October 12, 2022 11:19 Inactive
@vercel vercel bot temporarily deployed to Preview October 12, 2022 11:22 Inactive
Copy link
Collaborator

@BruceMacD BruceMacD left a comment

Choose a reason for hiding this comment

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

Thanks for tidying this up, I ran the command to re-generate the associated docs here, we keep these files in the repo so I added the generated file to the PR.

@vercel vercel bot temporarily deployed to Preview October 12, 2022 11:25 Inactive
@technovangelist technovangelist merged commit 1fda931 into main Oct 12, 2022
@technovangelist technovangelist deleted the matt/clidocgen branch October 12, 2022 14:32
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.

3 participants