Comments (6)
I would love to see the output of that rendered for this project! Give it a go if it’s not too much trouble and send it over so I can see the end result!
from charts.
I will make the example on the fork (with a manual generation) and if is nice, we can add actions to automate it (as next step)
let me prepare an example.
from charts.
@travisghansen
here is an initial example: https://github.com/varet80/democratic-csi-charts/tree/helm-docs/stable/democratic-csi
I have also a Draft PR in my fork, which shows what I changed, but Did not add description on everything.
Explained here: https://github.com/varet80/democratic-csi-charts/tree/helm-docs/stable/democratic-csi
from charts.
I see. And there is some sane way to run this in ci?
from charts.
generally it is 1 single command helm-docs and that all!
it has some githooks which helps you during commit to update docs! https://github.com/norwoodj/helm-docs (and reduce ci needs)
but also with github actions
I did it in my releasing step: https://github.com/k8sonlab/publiccharts/blob/591079daa51007724857421a4d201e1f7b242f8c/.github/workflows/compatibility.yaml#L71
there is also this: https://github.com/softwaremill/helm-docs-action/blob/main/action.yml
but I also have hooks: https://github.com/k8sonlab/publiccharts/blob/main/.pre-commit-config.yaml which does force run during commits.
once you have the executable it is simple as:
helm-docs <path>
and updates the readme.md based on gotemplate
from charts.
I see. I’ll look into it a little closer.
from charts.
Related Issues (20)
- Resource limits HOT 6
- unable to upgrade to 0.12.0 HOT 2
- Way to Move TrueNAS Secrets out of freenas-iscsi.yaml (values.yaml)? HOT 2
- Breaking changes: CustomResourceDefinition & field is immutable HOT 1
- Initial setup assist, installed truenas core last week HOT 12
- Regardless of chart version, latest democratic-csi image is always pulled and deployed HOT 3
- Mirror this Helm repo to ArtifactHub HOT 3
- Ability to set pods priority HOT 1
- lustre support from helm chart HOT 2
- k8s.gcr.io Image Registry Will Be Frozen HOT 2
- Questions about `datasetPermissions*` and `shareMaproot*` fields HOT 8
- appVersion set to 1.0 for all helm releases HOT 3
- Weird behavior on directory creation for generic NFS mounts HOT 1
- Can't find smb-client.yaml file in the examples HOT 1
- Helm error if defaultClass is set to true HOT 1
- Question about the grpc-proxy HOT 2
- how can I replicate data in 3 different truenas ?
- Split image and tag into different values in the helm chart
- CA_BUNDLE preventing snapshot controller from being installed
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 charts.