Comments (3)
Hey @ccremer, sorry I've been so long in responding. For various reasons I have little time to work on this project. This is.... A very complicated feature that I think is a very good idea but that I don't have time to build right now
from helm-docs.
Hey @ccremer I've thought a lot about this, and I think I probably won't add anything like this at this time. This is an incredibly complex feature that expands the scope of what this tool does substantially and I don't think it adds enough value to justify the code and documentation needed.
For now you can do:
# -- List of backup plans to create/ensure on startup
# @default -- list of objects of the form `{"plan": "selfResetAfter": "3s", "delay seconds": 30, "source": {"retention": "30d", "recursive": false} ... }`
Which would get rendered into the default column of the backupPlans field.
This seems like an admittedly clunkier way of achieving somewhat what you're trying to do here.
Is this okay for now? I'm going to close this issue for now. Happy to talk about other lighter-weight solutions
from helm-docs.
That's ok
However I just had a new implementation idea. What if the complex example is actually a different file, completely uncommented with valid YAML structure?
Let's say we have this:
$ cat values.yaml
znapzend:
# znapzend.backupPlans -- List of backup plans to create/ensure on startup, see
# [example/backup-plans.yaml](./example/backup-plans.yaml) for an example
# @import example/backup-plans.yaml
backupPlans: []
and this file
$ cat example/backup-plans.yaml
znapzend:
backup-plans:
# -- Source dataset path
- dataset: ""
plan: {} etc
That should keep the values.yaml free from this implementation, but maybe it's possible to load an additional yaml structure?
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.