msb-public
/
helm
mirror of https://github.com/helm/helm
1
0
Code Issues Projects Releases Wiki Activity

Fix markdown table in helm command doc

Browse Source 
The tables aren't rendered correctly because the syntax was wrong. Fixed it by applying the https://www.markdownguide.org/extended-syntax/#tables table syntax.

See https://helm.sh/docs/helm/helm/#synopsis for the wrong rendering.

![Broken table in html](https://imgur.com/bniKxO6)

Fix for helm/helm-www#575

Signed-off-by: Lüchinger Dominic <dev@snowgarden.ch>
pull/8025/head
Lüchinger Dominic 5 years ago
parent 6fc9353056
commit fb829c2c84
No known key found for this signature in database
GPG Key ID: 5768DD51B4D71C70
1 changed files with 10 additions and 14 deletions
Show Stats Download Patch File Download Diff File

24
cmd/helm/root.go
Unescape View File

@ -43,17 +43,15 @@ Common actions for Helm:
Environment variables: Environment variables:
+------------------+--------------------------------------------------------------------------------------------------------+ | Name | Description |
| Name | Description | |------------------------------------|-----------------------------------------------------------------------------------|
+------------------+--------------------------------------------------------------------------------------------------------+ | $XDG_CACHE_HOME | set an alternative location for storing cached files. |
| $XDG_CACHE_HOME | set an alternative location for storing cached files. | | $XDG_CONFIG_HOME | set an alternative location for storing Helm configuration. |
| $XDG_CONFIG_HOME | set an alternative location for storing Helm configuration. | | $XDG_DATA_HOME | set an alternative location for storing Helm data. |
| $XDG_DATA_HOME | set an alternative location for storing Helm data. | | $HELM_DRIVER | set the backend storage driver. Values are: configmap, secret, memory, postgres |
| $HELM_DRIVER | set the backend storage driver. Values are: configmap, secret, memory, postgres | | $HELM_DRIVER_SQL_CONNECTION_STRING | set the connection string the SQL storage driver should use. |
| $HELM_DRIVER_SQL_CONNECTION_STRING | set the connection string the SQL storage driver should use. | | $HELM_NO_PLUGINS | disable plugins. Set HELM_NO_PLUGINS=1 to disable plugins. |
| $HELM_NO_PLUGINS | disable plugins. Set HELM_NO_PLUGINS=1 to disable plugins. | | $KUBECONFIG | set an alternative Kubernetes configuration file (default "~/.kube/config") |
| $KUBECONFIG | set an alternative Kubernetes configuration file (default "~/.kube/config") |
+------------------+--------------------------------------------------------------------------------------------------------+
Helm stores configuration based on the XDG base directory specification, so Helm stores configuration based on the XDG base directory specification, so
@ -63,13 +61,11 @@ Helm stores configuration based on the XDG base directory specification, so
By default, the default directories depend on the Operating System. The defaults are listed below: By default, the default directories depend on the Operating System. The defaults are listed below:
+------------------+---------------------------+--------------------------------+-------------------------+
| Operating System | Cache Path | Configuration Path | Data Path | | Operating System | Cache Path | Configuration Path | Data Path |
+------------------+---------------------------+--------------------------------+-------------------------+ |------------------|---------------------------|--------------------------------|-------------------------|
| Linux | $HOME/.cache/helm | $HOME/.config/helm | $HOME/.local/share/helm | | Linux | $HOME/.cache/helm | $HOME/.config/helm | $HOME/.local/share/helm |
| macOS | $HOME/Library/Caches/helm | $HOME/Library/Preferences/helm | $HOME/Library/helm | | macOS | $HOME/Library/Caches/helm | $HOME/Library/Preferences/helm | $HOME/Library/helm |
| Windows | %TEMP%\helm | %APPDATA%\helm | %APPDATA%\helm | | Windows | %TEMP%\helm | %APPDATA%\helm | %APPDATA%\helm |
+------------------+---------------------------+--------------------------------+-------------------------+
` `
func newRootCmd(actionConfig *action.Configuration, out io.Writer, args []string) *cobra.Command { func newRootCmd(actionConfig *action.Configuration, out io.Writer, args []string) *cobra.Command {

Write Preview
Loading…
Cancel
Save