Title: Use helm-docs to generate Helm README.md · Issue #3226 · coder/coder · GitHub
Open Graph Title: Use helm-docs to generate Helm README.md · Issue #3226 · coder/coder
X Title: Use helm-docs to generate Helm README.md · Issue #3226 · coder/coder
Description: For v1 we have a table in the README that explains the values, their descriptions and what their defaults are. We should have a similar README for helm in v2 so people know what values are available. As part of adding the Helm chart I ha...
Open Graph Description: For v1 we have a table in the README that explains the values, their descriptions and what their defaults are. We should have a similar README for helm in v2 so people know what values are availabl...
X Description: For v1 we have a table in the README that explains the values, their descriptions and what their defaults are. We should have a similar README for helm in v2 so people know what values are availabl...
Opengraph URL: https://github.com/coder/coder/issues/3226
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Use helm-docs to generate Helm README.md","articleBody":"For v1 we have a table in the [README](https://github.com/coder/enterprise-helm/blob/432c0434b0be790da7224b04e06d5bc2c5a79a40/README.md#values) that explains the values, their descriptions and what their defaults are. We should have a similar README for helm in v2 so people know what values are available.\r\n\r\nAs part of adding the Helm chart I have already added [`helm-docs`](https://github.com/norwoodj/helm-docs)-compatible comments above each value so all that is left is writing the README template and adding CI to ensure it's generated properly.\r\n\r\nSuccess criteria:\r\n- Add `helm/README.md`\r\n - Links to our Helm installation documentation (after #3224)\r\n - Has a table of values generated by `helm-docs`\r\n- Add CI to ensure that `helm/README.md` stays up-to-date as part of the `fmt` job","author":{"url":"https://github.com/deansheather","@type":"Person","name":"deansheather"},"datePublished":"2022-07-26T18:26:07Z","url":"https://github.com/coder/coder/issues/3226"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:0378774b-f2e6-14f5-6711-8945729bc9d9 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | B90C:157C65:26AFD7E:33A0A09:6B01AD57 |
| html-safe-nonce | fdc7cb0aba5441a4e2f314428039a08eebee143bd43bcc37348d513f2b181b62 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCOTBDOjE1N0M2NToyNkFGRDdFOjMzQTBBMDk6NkIwMUFENTciLCJ2aXNpdG9yX2lkIjoiOTEyMTEyMDE1ODgwMTMwOTAxNSIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 647766d0d69a55a98248280c7ce9fe8cabe3e01ca215f66880a3460974278ab6 |
| hovercard-subject-tag | issue:1318607445 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/coder/coder/3226/issue_layout |
| twitter:image | https://opengraph.githubassets.com/accd4d71b495987ef01e3497aa7753a6aa22eda8ac247d239c0c6053d68a7dd5/coder/coder/issues/3226 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/accd4d71b495987ef01e3497aa7753a6aa22eda8ac247d239c0c6053d68a7dd5/coder/coder/issues/3226 |
| og:image:alt | For v1 we have a table in the README that explains the values, their descriptions and what their defaults are. We should have a similar README for helm in v2 so people know what values are availabl... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | deansheather |
| hostname | github.com |
| expected-hostname | github.com |
| None | cc5dfdd32f62ebd3223cab3af3aa2b268d3605218237326a48a99d1efd89495c |
| turbo-cache-control | no-preview |
| go-import | github.com/coder/coder git https://github.com/coder/coder.git |
| octolytics-dimension-user_id | 95932066 |
| octolytics-dimension-user_login | coder |
| octolytics-dimension-repository_id | 440752086 |
| octolytics-dimension-repository_nwo | coder/coder |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 440752086 |
| octolytics-dimension-repository_network_root_nwo | coder/coder |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 8c77c9e8439031ad54c75a250694842892f693e1 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width