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

Remove extra field so generated docs don't have duplicate descripti… #531

Merged
merged 3 commits into from
Feb 5, 2024

Conversation

chunter0
Copy link
Contributor

@chunter0 chunter0 commented Jan 29, 2024

If an operator has enabled field defined in the provided values skv2 will generate another line for the default enabled field found when building helm chart values.

E.g:

type glooAgent struct{
  enabled bool `desc: "enabled gloo agent component"
}

Prior to this change would result in the following lines existing in the generated reference doc

|glooAgent.enabled|bool|enabled gloo agent component|false|
|glooAgent.enabled|bool|Enable creation of the deployment/service.|true|

BOT NOTES:
resolves #532

@solo-changelog-bot
Copy link

Issues linked to changelog:
#532

Copy link
Contributor

@Rachael-Graham Rachael-Graham left a comment

Choose a reason for hiding this comment

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

LGTM on docs end

@soloio-bulldozer soloio-bulldozer bot merged commit 4893ca7 into main Feb 5, 2024
3 checks passed
@soloio-bulldozer soloio-bulldozer bot deleted the chunter/remove-extra-field branch February 5, 2024 16:26
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.

Remove extra enabled field when generating reference docs
3 participants