Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Backport of docs: Replace unicode quotes with ASCII quotes into release/1.16.x #18972

Conversation

hc-github-team-consul-core
Copy link
Contributor

Backport

This PR is auto-generated from #18950 to be assessed for backporting due to the inclusion of the label backport/1.16.

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


Description

Replaces unicode quotation marks with ASCII quotation marks.

For code examples, this fixes HCL decoding errors that would otherwise be raised when attempting to read the file.

Testing & Reproduction steps

  1. Create a configuration entry that contains unicode quotation marks.

    # proxy-defaults-with-unicode-quotes.hcl
    Kind = “proxy-defaults”
    Name = "global"
    Config = {
      envoy_dogstatsd_url = "udp://127.0.0.1:8125"
    }
  2. Attempt to save the configuration entry.

    $ consul config write proxy-defaults-with-unicode-quotes.hcl
    Failed to decode config entry input: Failed to decode config entry input: At 1:15: illegal char
    

The config entry fails to be decoded due to the unsupported unicode character.

Below is the behavior with the unicode quotes removed.

  1. Create a configuration entry with only ASCII quotation marks.

    # proxy-defaults-with-ascii-quotes.hcl
    Kind = "proxy-defaults"
    Name = "global"
    Config = {
      envoy_dogstatsd_url = "udp://127.0.0.1:8125"
    }
  2. Attempt to write the configuration entry.

    $ consul config write proxy-defaults-with-ascii-quotes.hcl                                                                                         
    Config entry written: proxy-defaults/global
    

PR Checklist

  • updated test coverage
  • external facing docs updated
  • appropriate backport labels added
  • not a security concern

Overview of commits

@hc-github-team-consul-core hc-github-team-consul-core force-pushed the backport/docs/replace-unicode-quotes-with-ascii/supposedly-alive-terrier branch from 100fbed to 73c4b3b Compare September 21, 2023 22:17
@hc-github-team-consul-core hc-github-team-consul-core force-pushed the backport/docs/replace-unicode-quotes-with-ascii/supposedly-alive-terrier branch from 97db1f4 to 9d1bea1 Compare September 21, 2023 22:17
@github-actions github-actions bot added type/docs Documentation needs to be created/updated/clarified theme/consul-terraform-sync Relating to Consul Terraform Sync and Network Infrastructure Automation labels Sep 21, 2023
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Auto approved Consul Bot automated PR

@vercel vercel bot temporarily deployed to Preview – consul September 21, 2023 22:28 Inactive
@hc-github-team-consul-core hc-github-team-consul-core merged commit 6d18f20 into release/1.16.x Sep 21, 2023
49 of 50 checks passed
@hc-github-team-consul-core hc-github-team-consul-core deleted the backport/docs/replace-unicode-quotes-with-ascii/supposedly-alive-terrier branch September 21, 2023 22:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
theme/consul-terraform-sync Relating to Consul Terraform Sync and Network Infrastructure Automation type/docs Documentation needs to be created/updated/clarified
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants