consul icon indicating copy to clipboard operation
consul copied to clipboard

Backport of [docs] use values.yaml instead of config.yaml everywhere for helm configurations into stable-website

Open hc-github-team-consul-core opened this issue 3 years ago • 1 comments

Backport

This PR is auto-generated from #14554 to be assessed for backporting due to the inclusion of the label type/docs-cherrypick.

WARNING automatic cherry-pick of commits failed. Commits will require human attention.

merge conflict error: POST https://api.github.com/repos/hashicorp/consul/merges: 409 Merge conflict []

The below text is copied from the body of the original PR.


Description

We have been using values.yaml and config.yaml interchangeably in our docs to describe the custom helm configurations. This PR proposes that we use values.yaml to describe the helm chart configurations and use config.yaml in existing places where it is meant to describe other objects (like CRDs, etc).

This aligns our docs with whats in the consul-k8s repo and also what is described here: https://helm.sh/docs/chart_template_guide/values_files/

PR Checklist

  • [ ] updated test coverage
  • [x] external facing docs updated
  • [x] not a security concern

Overview of commits
  • 208dd1452ae2965bd176769ac4e2358aba5c7fa4

CLA assistant check

Thank you for your submission! We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution. Read and sign the agreement

Learn more about why HashiCorp requires a CLA and what the CLA includes


5 out of 6 committers have signed the CLA.

  • [x] hc-github-team-consul-core
  • [x] Jeff-Apple
  • [x] trujillo-adam
  • [x] david-yu
  • [x] nathancoleman
  • [ ] temp

temp seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you already have a GitHub account, please add the email address used for this commit to your account.

Have you signed the CLA already but the status is still pending? Recheck it.

hashicorp-cla avatar Sep 09 '22 20:09 hashicorp-cla

This pull request has been automatically flagged for inactivity because it has not been acted upon in the last 60 days. It will be closed if no new activity occurs in the next 30 days. Please feel free to re-open to resurrect the change if you feel this has happened by mistake. Thank you for your contributions.

github-actions[bot] avatar Nov 12 '22 01:11 github-actions[bot]