rapidsai / frigate

Frigate is a tool for automatically generating documentation for your Helm charts
https://frigate.readthedocs.io
Other
83 stars 25 forks source link

How to disable the formatting for the helm chart name ? #15

Closed raul1991 closed 3 years ago

raul1991 commented 4 years ago

First of all, Damn! this tool is fantastic just does what it says, perfectly.

Now, the issue is that the helm chart initial character gets rendered as upper case. Is there a flag to disable it ?

Example:

description: Helm chart for foo-bar
name: foo-bar
version: 0.9.0-15

Expectation

Chart name to be rendered as is

Actual

chart name is rendered as Foo-bar

raul1991 commented 4 years ago

Ok, I see this link and maybe overriding a template variable {{name}} would help here but where should I place it or tell frigate about it ? .frigade ?

raul1991 commented 4 years ago

I guess I was too fast in creating the issue because after reading the docs I got this working. So put a file named .frigate with the following content in your helm chart directory

{% extends "markdown.jinja2" %}

{% block title -%}
# {{ name }}
{%- endblock %}
jacobtomlinson commented 4 years ago

Thanks for raising this @raul1991 and thanks for the praise!

I think this may have been fixed by #14.

raul1991 commented 3 years ago

I think the pull request removed the support for capitalization of the comments.

This issue was regarding the capitalization of the chart name inthe rendered output file. This could be done by overriding the respective template inside a .frigate file. I didn't see it that time so raised an issue but lets close this now.