René's URL Explorer Experiment


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

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@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-profiling0
react-import-mapreact,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-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:0378774b-f2e6-14f5-6711-8945729bc9d9
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-idB90C:157C65:26AFD7E:33A0A09:6B01AD57
html-safe-noncefdc7cb0aba5441a4e2f314428039a08eebee143bd43bcc37348d513f2b181b62
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCOTBDOjE1N0M2NToyNkFGRDdFOjMzQTBBMDk6NkIwMUFENTciLCJ2aXNpdG9yX2lkIjoiOTEyMTEyMDE1ODgwMTMwOTAxNSIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9
visitor-hmac647766d0d69a55a98248280c7ce9fe8cabe3e01ca215f66880a3460974278ab6
hovercard-subject-tagissue:1318607445
github-keyboard-shortcutsrepository,issues,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///voltron/issues_fragments/issue_layout
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/coder/coder/3226/issue_layout
twitter:imagehttps://opengraph.githubassets.com/accd4d71b495987ef01e3497aa7753a6aa22eda8ac247d239c0c6053d68a7dd5/coder/coder/issues/3226
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/accd4d71b495987ef01e3497aa7753a6aa22eda8ac247d239c0c6053d68a7dd5/coder/coder/issues/3226
og:image:altFor 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:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernamedeansheather
hostnamegithub.com
expected-hostnamegithub.com
Nonecc5dfdd32f62ebd3223cab3af3aa2b268d3605218237326a48a99d1efd89495c
turbo-cache-controlno-preview
go-importgithub.com/coder/coder git https://github.com/coder/coder.git
octolytics-dimension-user_id95932066
octolytics-dimension-user_logincoder
octolytics-dimension-repository_id440752086
octolytics-dimension-repository_nwocoder/coder
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id440752086
octolytics-dimension-repository_network_root_nwocoder/coder
turbo-body-classeslogged-out env-production page-responsive
disable-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release8c77c9e8439031ad54c75a250694842892f693e1
ui-targetfull
theme-color#1e2327
color-schemelight dark
react-app-nameissues

Links:

Skip to contenthttps://github.com/coder/coder/issues/3226#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fcoder%2Fcoder%2Fissues%2F3226
GitHubRepository hosting, code review, and collaborationhttps://github.com/platform
CopilotAI coding agent for tasks, projects, and automated workhttps://github.com/features/copilot
ActionsCI/CD and automationhttps://github.com/features/actions
Code QualityQuality analysis, fixes, and enforcementhttps://github.com/features/code-quality
CodespacesCloud development environmentshttps://github.com/features/codespaces
Code SecurityVulnerability detection and remediationhttps://github.com/security/advanced-security/code-security
Secret ProtectionSecret scanning and leak preventionhttps://github.com/security/advanced-security/secret-protection
All Featureshttps://github.com/features
Documentationhttps://docs.github.com/en
Traininghttps://learn.github.com/skills
Certificationshttps://learn.github.com/credentials
Build with Copilothttps://github.com/features/ai
Customize Copilothttps://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview
Integrationshttps://github.com/marketplace
Trending reposhttps://github.com/trending
GitHub Sponsorshttps://github.com/open-source/sponsors
Developer articleshttps://github.com/resources/articles
ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place.https://github.blog/changelog/
Enterpriseshttps://github.com/enterprise
Teamhttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
See all industrieshttps://github.com/solutions/industry
Why GitHubhttps://github.com/why-github
Customer Storieshttps://github.com/customer-stories
Business insightshttps://github.com/solutions/executive-insights
Trust Centerhttps://github.com/trust-center
GitHub Advanced SecurityEnterprise-grade code securityhttps://github.com/security/advanced-security
Copilot for businessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Documentationhttps://docs.github.com/en
Resource centerhttps://github.com/resources
Bloghttps://github.blog/
Events & webinarshttps://github.com/resources/events
Community Forumhttps://github.com/orgs/community/discussions
Customer Storieshttps://github.com/customer-stories
Integrationshttps://github.com/marketplace
Customer supporthttps://help.github.com/
Traininghttps://learn.github.com/skills
GitHub Statushttps://www.githubstatus.com/
Abouthttps://github.com/about
Partnershttps://github.com/partners
Changeloghttps://github.blog/changelog/
GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub.https://githubuniverse.com/
Pricinghttps://github.com/pricing
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fcoder%2Fcoder%2Fissues%2F3226
Sign uphttps://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fvoltron%2Fissues_fragments%2Fissue_layout&source=header-repo&source_repo=coder%2Fcoder
Reloadhttps://github.com/coder/coder/issues/3226
Reloadhttps://github.com/coder/coder/issues/3226
Reloadhttps://github.com/coder/coder/issues/3226
coderhttps://github.com/coder
coderhttps://github.com/coder/coder
Codehttps://github.com/coder/coder
Issues320 (320)https://github.com/coder/coder/issues
Pull requests470 (470)https://github.com/coder/coder/pulls
Discussionshttps://github.com/coder/coder/discussions
Actionshttps://github.com/coder/coder/actions
Projectshttps://github.com/coder/coder/projects
Security and quality49 (49)https://github.com/coder/coder/security
Insightshttps://github.com/coder/coder/insights
https://github.com/coder/coder
New issuehttps://github.com/login?return_to=https://github.com/coder/coder/issues/3226
New issuehttps://github.com/login?return_to=https://github.com/coder/coder/issues/3226
#3268https://github.com/coder/coder/pull/3268
Use helm-docs to generate Helm README.mdhttps://github.com/coder/coder/issues/3226#top
#3268https://github.com/coder/coder/pull/3268
https://github.com/deansheather
apiArea: HTTP APIhttps://github.com/coder/coder/issues?q=state%3Aopen%20label%3A%22api%22
docsArea: coder.com/docshttps://github.com/coder/coder/issues?q=state%3Aopen%20label%3A%22docs%22
https://github.com/deansheather
deansheatherhttps://github.com/deansheather
on Jul 26, 2022https://github.com/coder/coder/issues/3226#issue-1318607445
READMEhttps://github.com/coder/enterprise-helm/blob/432c0434b0be790da7224b04e06d5bc2c5a79a40/README.md#values
helm-docshttps://github.com/norwoodj/helm-docs
Write documentation for how to use helm chart #3224https://github.com/coder/coder/issues/3224
deansheatherhttps://github.com/deansheather
docsArea: coder.com/docshttps://github.com/coder/coder/issues?q=state%3Aopen%20label%3A%22docs%22
apiArea: HTTP APIhttps://github.com/coder/coder/issues?q=state%3Aopen%20label%3A%22api%22
on Jul 26, 2022https://github.com/coder/coder/issues/3226#event-7067246405
deansheatherhttps://github.com/deansheather
on Jul 26, 2022https://github.com/coder/coder/issues/3226#event-7067246461
deansheatherhttps://github.com/deansheather
completedhttps://github.com/coder/coder/issues?q=is%3Aissue%20state%3Aclosed%20archived%3Afalse%20reason%3Acompleted
#3268https://github.com/coder/coder/pull/3268
on Aug 18, 2022https://github.com/coder/coder/issues/3226#event-7215938690
Sign up for freehttps://github.com/signup?return_to=https://github.com/coder/coder/issues/3226
Sign in to commenthttps://github.com/login?return_to=https://github.com/coder/coder/issues/3226
deansheatherhttps://github.com/deansheather
apiArea: HTTP APIhttps://github.com/coder/coder/issues?q=state%3Aopen%20label%3A%22api%22
docsArea: coder.com/docshttps://github.com/coder/coder/issues?q=state%3Aopen%20label%3A%22docs%22
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.