Skip to content

Commit

Permalink
chore: updates generated chart documentation for version v1.12.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@norwoodj
norwoodj committed Dec 21, 2023
1 parent e9aaa42 commit d8667d2
Show file tree
Hide file tree
Showing 23 changed files with 30 additions and 25 deletions.
2 changes: 1 addition & 1 deletion example-charts/best-values-example/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ One of the best values parsing example charts here, exhibits several more compli
| statefulset.podLabels | object | `{}` | The labels to be applied to instances of the database |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)
2 changes: 1 addition & 1 deletion example-charts/custom-template/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,4 @@ $ helm install my-release foo-bar/custom-template
| controller.service.type | string | `"LoadBalancer"` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)
2 changes: 1 addition & 1 deletion example-charts/custom-value-notation-type/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1105,4 +1105,4 @@ string
</table>

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)
2 changes: 1 addition & 1 deletion example-charts/dos-line-endings/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ A chart whose values file has dos line endings rather than unix ones
| livenessProbe.httpGet.port | string | `"http"` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)
12 changes: 7 additions & 5 deletions example-charts/files-values/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,11 @@ dataSecret:
resource2.yaml: c29tZToKICByZXNvdXJjZTogImJsYWgyIg==
```

File: Chart.yaml
File: somefile.yaml
File: templates/resource1.yaml
File: templates/resource2.yaml
File: values.yaml
File: example-charts/files-values/Chart.yaml
File: example-charts/files-values/somefile.yaml
File: example-charts/files-values/templates/resource1.yaml
File: example-charts/files-values/templates/resource2.yaml
File: example-charts/files-values/values.yaml

## Values

Expand All @@ -67,3 +67,5 @@ File: values.yaml
| statefulset.livenessProbe | object | `{"enabled":false}` | Configure the healthcheck for the database |
| statefulset.podLabels | object | `{}` | The labels to be applied to instances of the database |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)
2 changes: 1 addition & 1 deletion example-charts/full-template/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -163,4 +163,4 @@ Kubernetes: `<=1.18`
| controller.service.type | string | `"LoadBalancer"` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)
2 changes: 2 additions & 0 deletions example-charts/fully-documented/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,5 @@ A simple wrapper around the stable/nginx-ingress chart that adds a few of our co
| controller.image.tag | string | `"18.0831"` | The tag of the image of the controller |
| controller.name | string | `"controller"` | The name of the controller |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)
2 changes: 1 addition & 1 deletion example-charts/funky-version/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ A very simple chart with a funky version
* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/funky-version>

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)
2 changes: 1 addition & 1 deletion example-charts/helm-3/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@ A simple wrapper around the stable/nginx-ingress chart that adds a few of our co
| controller.service.type | string | `"LoadBalancer"` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)
2 changes: 1 addition & 1 deletion example-charts/ignored-values-example/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@ Based on best-values-example
| statefulset.podLabels | object | `{}` | The labels to be applied to instances of the database |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)
2 changes: 1 addition & 1 deletion example-charts/most-empty/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ __|_____________
```

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)
2 changes: 1 addition & 1 deletion example-charts/nginx-ingress-but-auto-comments/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@ A simple wrapper around the stable/nginx-ingress chart that adds a few of our co
| controller.service.type | string | `"LoadBalancer"` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)
2 changes: 1 addition & 1 deletion example-charts/nginx-ingress/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@ A simple wrapper around the stable/nginx-ingress chart that adds a few of our co
| controller.service.type | string | `"LoadBalancer"` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)
2 changes: 1 addition & 1 deletion example-charts/no-requirements/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ A simple chart that installs, let's say PrometheusRules, that needs no sub-chart
| rules.statusCodes.codes.5xx.threshold | float | `1.5` | Threshold percentage of 5xx responses above which the alert will fire |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)
2 changes: 1 addition & 1 deletion example-charts/no-values/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ A very simple chart that doesn't even need any values for customization
* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/no-values>

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)
1 change: 1 addition & 0 deletions example-charts/sections/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -177,3 +177,4 @@ null
</tr>
</tbody>
</table>

2 changes: 1 addition & 1 deletion example-charts/sections/README.md.gotmpl
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Sections

This creates values, but sectioned into own section tables if a seciton comment is provided.
This creates values, but sectioned into own section tables if a section comment is provided.

{{ template "chart.valuesSection" . }}

Expand Down
2 changes: 1 addition & 1 deletion example-charts/special-characters-but-auto-comments/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ A chart demonstrating handling of special characters in values files
| htmlSnippets.two | string | `""` | Let's put it in the description <html></html> |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)
2 changes: 1 addition & 1 deletion example-charts/special-characters/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ A chart demonstrating handling of special characters in values files
| htmlSnippets.two | string | `""` | Let's put it in the description <html></html> |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)
2 changes: 1 addition & 1 deletion example-charts/umbrella/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ A chart demonstrating that values documentation from child charts are aggregated
| sub-b.mySubKeyB | string | `"my-sub-value-b"` | Value for sub-chart B |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)
2 changes: 1 addition & 1 deletion example-charts/umbrella/charts/sub-a/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ A sub-chart.
| mySubKeyA | string | `"my-sub-value-a"` | Value for sub-chart A |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)
2 changes: 1 addition & 1 deletion example-charts/umbrella/charts/sub-b/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ A sub-chart.
| mySubKeyB | string | `"my-sub-value-b"` | Value for sub-chart B |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)
2 changes: 1 addition & 1 deletion example-charts/umbrella/charts/sub-c/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ A sub-chart.
| global | object | `{}` | |

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

0 comments on commit d8667d2

Please sign in to comment.