Comments (9)
Would be good if this was implemented the same way as Bitnami's readme-generator-for-helm that you can specify fields to skip in the values.yaml
itself.
https://github.com/bitnami-labs/readme-generator-for-helm#metadata
This would scale better when generating docs for multiple charts compared to using --skip-values
flag.
from helm-docs.
@Anticom doc directive is already merged. It's documented here: https://github.com/norwoodj/helm-docs#ignoring-values
I don't know what are the plans for --skip-values
flag. I can envision a case when it's useful, but I don't know what are the plans for this.
@norwoodj As the original question/feature request is resolved, I would close this issue.
from helm-docs.
There is not at present, but I think this is a reasonable ask. I can envision a flag (that can be repeated) like --skip-values deployment.replicas
or similar. I can implement this when I get more time, (I'm very busy with my real job at present). Please feel free to submit a PR though.
from helm-docs.
No worries! I'll try and pull something together when I have a minute. Just wanted to make sure I wasn't missing something.
from helm-docs.
from helm-docs.
@K1Hyve @Pothulapati @mjpitz I needed something similar to this as well, but was able to implement it by generating the table myself in a custom template (I provide an example in an unrelated enhancement request I just raised here #107).
from helm-docs.
PR for this: Add option for ignoring values #141
from helm-docs.
There is not at present, but I think this is a reasonable ask. I can envision a flag (that can be repeated) like --skip-values deployment.replicas or similar. I can implement this when I get more time, (I'm very busy with my real job at present). Please feel free to submit a PR though.
I'd prefer configuring which values to skip via a special doc comment directive rather than a flag for helm-docs cli. My reasoning / use case is setting some values on sub chart's values. Since those are (hopefully) documented in the referenced chart, it would be superflous to have documentation for those overrides generated in my chart.
Alternatively the --skip-values
flag either would have to work recursively or it would have to support globbing patterns. Otherwise I'd have to specify a huge set of values to be ignored / skipped.
from helm-docs.
doc directive is already merged. It's documented here: https://github.com/norwoodj/helm-docs#ignoring-values
Oh, I've totally missed that. Thanks for the heads-up! 🚀
from helm-docs.
Related Issues (20)
- document-dependency-values does not work with OCI dependency HOT 3
- Cannot include mustache/handlebar templates in example docs HOT 2
- Support for creating docs of named templates in library charts HOT 1
- Ignore comment HOT 1
- feature: output results as json (or other formats) HOT 2
- feature request: "Strict mode" HOT 25
- Implement something like helm's `include` function
- Pipe `|` breaks table output of `values.yml`
- helm-docs as pre-commit marked as failed but successfully replaces files HOT 1
- Add support for conditional dependencies
- Output docs for values that are commented out HOT 4
- helm-docs write extra empty line HOT 5
- Q&A - Auto sorting HOT 2
- custom template not defined error
- General Cleanup
- Notation annotation ignored when value is null
- How to document a list of objects?
- v1.11.1 does not have a release HOT 2
- helm-docs for helmfile HOT 6
- @latest produces different files than last release (1.11.0), missing a newline at the end of file HOT 4
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.