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

chore(konvoyctl) fixing product name #67

Merged
merged 1 commit into from
Sep 5, 2019
Merged

chore(konvoyctl) fixing product name #67

merged 1 commit into from
Sep 5, 2019

Conversation

subnetmarco
Copy link
Contributor

Minor documentation fix.

@@ -1,7 +1,7 @@
# konvoyctl

```
Management tool for Konvoy Service Mesh.
Copy link
Contributor

Choose a reason for hiding this comment

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

HELP.md is auto-generated.

Instead, you have to:

  1. change that string in the source code - https://github.com/Kong/konvoy/blob/master/components/konvoy-control-plane/app/konvoyctl/cmd/root.go#L39-L40
  2. run make check to re-generate HELP.md

Copy link
Contributor

Choose a reason for hiding this comment

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

Sorry, use make docs instead (it doesn't require extra development tools to be installed)

@subnetmarco subnetmarco force-pushed the docs/konvoyctl branch 2 times, most recently from 824f8e2 to 1277739 Compare July 24, 2019 15:26
@subnetmarco
Copy link
Contributor Author

@yskopets I have implemented your suggestion. If HELP.md and other files are auto-generated, do we still want to push it every time or should we suggest - as part of the dev flow - to run make docs if somebody wants to generate the docs?

@subnetmarco subnetmarco changed the title docs(konvoyctl) fixing product name chore(konvoyctl) fixing product name Jul 24, 2019
@yskopets
Copy link
Contributor

@subnetmarco define the desired behaviour and we will implement it

@yskopets yskopets merged commit 67512bc into master Sep 5, 2019
@yskopets yskopets deleted the docs/konvoyctl branch September 8, 2019 01:10
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.

None yet

2 participants