Giter Club home page Giter Club logo

Comments (5)

YevheniiPokhvalii avatar YevheniiPokhvalii commented on July 26, 2024 12

If you install this tool with "Go" this field is absent. Means that it is inconsistent. Better off having a simple flag for this field because when you generate new helm-docs with the new version tool mostly you have is just a different footer.
It's only for a user convenience especially when you have helm-docs diff checks at the server side.

from helm-docs.

YevheniiPokhvalii avatar YevheniiPokhvalii commented on July 26, 2024 5

You just have to define a custom README.md.gotmpl without the {{ template "helm-docs.versionFooter" . }} part.

Why not to have just a flag to turn it off?

from helm-docs.

sc250024 avatar sc250024 commented on July 26, 2024 2

You just have to define a custom README.md.gotmpl without the {{ template "helm-docs.versionFooter" . }} part.

Why not to have just a flag to turn it off?

Because that's an anti-pattern. If you start going down the path of "we need a CLI flag / toggle for every single feature" you run into something very complicated, very quickly. It's much better from a practical, and maintainability perspective, if you cover most of the use cases that people want, and template the rest. If you want to see where the road you desire leads to, look no further than the git CLI. Most people avoid any sort of interaction with that if possible because it has too many options.

from helm-docs.

RetGal avatar RetGal commented on July 26, 2024 1

You just have to define a custom README.md.gotmpl without the {{ template "helm-docs.versionFooter" . }} part.

from helm-docs.

gionn avatar gionn commented on July 26, 2024

You just have to define a custom README.md.gotmpl without the {{ template "helm-docs.versionFooter" . }} part.

that would actually clutter the repository where I need to copy-paste the same template just to get rid of the final signature.

It's really useful to know which is the exact version on which a README has been generated? The most simple solution for me is just to get rid of the version e.g.

Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)

from helm-docs.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.