Comments (4)
norwoodj
commented on August 15, 2024
Agreed, I'll merge a PR, or get to this myself... someday soon
from helm-docs.
cebidhem
commented on August 15, 2024
Hi @norwoodj ,
I'm using your project for our Helm charts documentation - thanks for that - and I was looking for a good first issue I could contribute with.
Please let me know in the PR if there's anything I should improve.
Cheers!
from helm-docs.
johbo
commented on August 15, 2024
Just bumped into this issue after trying to figure out why the requirementsSection is not rendering anything.
Think the mentioned pull request #161 looks like a solution to me. Anything that would have to be tweaked on the PR to make it increase it's chances of being merged?
from helm-docs.
johbo
commented on August 15, 2024
Following up on my own message to avoid that anyone else gets trapped in the same way:
My issue was caused by a wrong value in my Chart.yaml regarding the attribute apiVersion. If that's set to "v1", then helm-docs is correctly ignoring the attribute dependencies.
The mentioned PR and this issue are about consistent naming only I think.
from helm-docs.
Related Issues (20)
- [Bug]: README shows the repo name as jnorwood/helm-docs rather than norwoodj/helm-docs in pre-commit examples
- [security] Vulnerabilities in the Container Image HOT 2
- Is it possible to add custom fields and use those values in generating docs
- [Feat]: Add an option for "deprecation warning" for a value HOT 1
- Collision between the actual helm-docs commands and the regular Markdown documentation of the helm charts HOT 1
- [Bug]: Segmentation violation when using templates in `values.yml` HOT 1
- [Bug]: Error with my go1.20 cannot compile Go 1.22 code HOT 1
- [Feat]: git-hook HOT 3
- [Feat]: pre-commit helm-docs-container pin docker version by default
- [Bug]: `helm-docs.versionFooter` missing when installing tool using Go HOT 1
- [Feat]: Documenting values not explicitly present in values.yaml file
- [Feat]: Fail if specified template does not exist
- [Feat]: Add markdown description to Sections
- [Bug]: Always failing when using the --documentation-strict-mode flag HOT 1
- pre-commit scans the file only the first time HOT 1
- [Bug]: Subcharts Directory Structure not working with helm-docs
- [Feat]: Set badge color based on version
- [Bug]: pre-commit complains: 'go: updates to go.mod needed' for v1.14.0 HOT 4
- [Bug]: Release tag missing `v` prefix HOT 13
- [Feat]: Add `skip-footer-version` flag HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from helm-docs.