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

Added spec params description #1245

Merged
merged 3 commits into from
Sep 4, 2024
Merged

Added spec params description #1245

merged 3 commits into from
Sep 4, 2024

Conversation

AndrewChubatiuk
Copy link
Collaborator

@AndrewChubatiuk AndrewChubatiuk commented Aug 17, 2024

related issues #1244 #255

  • expose spec urls in params description
  • render param object in REAMDE as yaml

@github-actions github-actions bot added the k8s-stack k8s-stack helm chart related issue label Aug 17, 2024
@github-actions github-actions bot added agent vmagent helm chart related issue alert vmalert helm chart related issue auth vmauth helm chart related issue cluster vmcluster helm chart related issue operator operator helm chart related issue single VictoriaMetrics Single node helm chart related issue anomaly vmanomaly logs-single labels Aug 17, 2024
@AndrewChubatiuk AndrewChubatiuk force-pushed the spec-description branch 5 times, most recently from 2fcb1ed to 3bf3992 Compare August 17, 2024 12:13
Copy link
Contributor

@Haleygo Haleygo left a comment

Choose a reason for hiding this comment

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

hmm, I'm not sure about using HTML tags, they make README better but the values.yaml is a bit messy.

@AndrewChubatiuk
Copy link
Collaborator Author

I would also like to keep markdown tables instead of html ones, but multiline content breaks markdown tables and markdown is not rendered inside html. I can add to hugo-docs a PR, which adds function, which allow markdown to html conversion

@AndrewChubatiuk AndrewChubatiuk force-pushed the spec-description branch 4 times, most recently from 36bf922 to 30367d7 Compare August 19, 2024 13:52
@AndrewChubatiuk
Copy link
Collaborator Author

AndrewChubatiuk commented Aug 19, 2024

removed HTML tags from values and and rendered documentation by helm-docs binary from this PR
temporary added docker image that contains my fork

@AndrewChubatiuk AndrewChubatiuk force-pushed the spec-description branch 4 times, most recently from da56508 to 03cfe3e Compare August 22, 2024 12:18
@AndrewChubatiuk AndrewChubatiuk force-pushed the spec-description branch 3 times, most recently from 4b2c455 to 5f42f62 Compare September 3, 2024 09:27
@AndrewChubatiuk
Copy link
Collaborator Author

@Haleygo
Since there's no activity in helm-docs repo for a month, so I've built a docker image with my fork
could you please review it again?

@Haleygo
Copy link
Contributor

Haleygo commented Sep 3, 2024

# -- Extra Volume Mounts for the container
extraVolumeMounts:
[]
# - name: example
# mountPath: /example

A minor question: is there a way to support value's comment without adding the prefix # --?
I'm just concerned that I or other contributors might forget to add this for new values in the future.

@AndrewChubatiuk
Copy link
Collaborator Author

AndrewChubatiuk commented Sep 3, 2024

as far as i know and also you can see it in code helm-docs expects all comments to start with # -- to take them into account. Also I like this idea as this approach allows to put a whole YAML subtree in a values column if it's comment starts with #--, which is useful in a case of huge configuration object, like some CR spec, or alertmanager config, etc without a need to document each default parameter

Copy link
Contributor

@Haleygo Haleygo left a comment

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
agent vmagent helm chart related issue alert vmalert helm chart related issue anomaly vmanomaly auth vmauth helm chart related issue cluster vmcluster helm chart related issue k8s-stack k8s-stack helm chart related issue logs-single operator operator helm chart related issue single VictoriaMetrics Single node helm chart related issue
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants