Revamp config docs with helm-docs

[michaellzc]

This PR added autogen docs based on values.yaml.

charts/<chart_name>/README.md should no longer be edited, and changes should be made in charts/<chart_name>/README.md.gotmpl

View the rendered version here

• https://github.com/sourcegraph/deploy-sourcegraph-helm/tree/02-25-Revamp_config_docs_with_helm-docs/charts/sourcegraph
• https://github.com/sourcegraph/deploy-sourcegraph-helm/tree/02-25-Revamp_config_docs_with_helm-docs/charts/sourcegraph-migrator

Test plan

Run ./scripts/helm-docs.sh, you should be able to generate the README.md

close https://github.com/sourcegraph/sourcegraph/issues/31016

[michaellzc]

Current dependencies on/for this PR:

• main
  • PR Revamp config docs with helm-docs #50 (this PR)
    • PR Add kustomize migration path #54
    • PR Add examples for using external redis #53
    • PR Support custom service account name #52

This comment was auto-generated by Graphite.

[caugustus-sourcegraph]

Nice work! Thanks for slogging through all this.

Side note - when you squash commits during an open review, it makes it hard for reviewers to tell what has changed since the PR was first opened. It's a faster and more reliable review cycle if fixes are kept as separate commits until the PR is merged.

[michaellzc]

Nice work! Thanks for slogging through all this.

Side note - when you squash commits during an open review, it makes it hard for reviewers to tell what has changed since the PR was first opened. It's a faster and more reliable review cycle if fixes are kept as separate commits until the PR is merged.

Good call out! I can imagine it's pretty hard to inspect the diff again for large PR like this.

[michaellzc]

Graphite Merge Job

Current status: ✅ Merged

This pull request was successfully merged as part of a stack.

This comment was auto-generated by Graphite.

Job Reference: yNqXdfNl9dvIL5h0XluD