Skip to content

Backport of docs: Fix HCL, JSON, and YAML syntax errors into release/1.16.x#18891

Merged
hc-github-team-consul-core merged 1 commit into
release/1.16.xfrom
backport/docs/fix-code-block-syntax-errors/luckily-strong-caribou
Sep 19, 2023
Merged

Backport of docs: Fix HCL, JSON, and YAML syntax errors into release/1.16.x#18891
hc-github-team-consul-core merged 1 commit into
release/1.16.xfrom
backport/docs/fix-code-block-syntax-errors/luckily-strong-caribou

Conversation

@hc-github-team-consul-core
Copy link
Copy Markdown
Collaborator

@hc-github-team-consul-core hc-github-team-consul-core commented Sep 19, 2023

Backport

This PR is auto-generated from #18879 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

This commit fixes syntax errors in HCL, JSON, and YAML example configurations. In some cases, it replaces the code example with the proper format for the code block.

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 requested a review from a team as a code owner September 19, 2023 15:40
@hc-github-team-consul-core hc-github-team-consul-core requested a review from a team September 19, 2023 15:40
@hc-github-team-consul-core hc-github-team-consul-core force-pushed the backport/docs/fix-code-block-syntax-errors/luckily-strong-caribou branch from 6628ce1 to 8b7fd59 Compare September 19, 2023 15:40
@hc-github-team-consul-core hc-github-team-consul-core requested review from jeanneryan and shore and removed request for a team September 19, 2023 15:40
@hc-github-team-consul-core hc-github-team-consul-core force-pushed the backport/docs/fix-code-block-syntax-errors/luckily-strong-caribou branch from 48b795e to 6fbb38a Compare September 19, 2023 15:40
github-team-consul-core-pr-approver
github-team-consul-core-pr-approver approved these changes Sep 19, 2023
View reviewed changes
Copy link
Copy Markdown
Collaborator

@github-team-consul-core-pr-approver github-team-consul-core-pr-approver left a comment

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

@github-actions github-actions Bot added type/docs Documentation needs to be created/updated/clarified theme/api Relating to the HTTP API interface theme/health-checks Health Check functionality theme/acls ACL and token generation theme/cli Flags and documentation for the CLI interface theme/config Relating to Consul Agent configuration, including reloading theme/ui Anything related to the UI theme/connect Anything related to Consul Connect, Service Mesh, Side Car Proxies theme/telemetry Anything related to telemetry or observability type/ci Relating to continuous integration (CI) tooling for testing or releases pr/dependencies PR specifically updates dependencies of project theme/envoy/xds Related to Envoy support theme/contributing Additions and enhancements to community contributing materials theme/internals Serf, Raft, SWIM, Lifeguard, Anti-Entropy, locking topics theme/consul-terraform-sync Relating to Consul Terraform Sync and Network Infrastructure Automation labels Sep 19, 2023
@blake @im2nguyen
docs: Fix HCL, JSON, and YAML syntax errors (#18879)
6cefcd0 
This commit fixes syntax errors in HCL, JSON, and YAML example
configurations. In some cases, it replaces the code example with the
proper format for the code block.

Also fixes HCL formatting and misc opportunistic updates to codeblock.

Co-authored-by: Tu Nguyen <im2nguyen@gmail.com>
@blake blake force-pushed the backport/docs/fix-code-block-syntax-errors/luckily-strong-caribou branch from 6fbb38a to 6cefcd0 Compare September 19, 2023 18:07
@blake blake removed request for a team, jeanneryan and shore September 19, 2023 18:07
@hc-github-team-consul-core hc-github-team-consul-core merged commit c38b9bf into release/1.16.x Sep 19, 2023
@hc-github-team-consul-core hc-github-team-consul-core deleted the backport/docs/fix-code-block-syntax-errors/luckily-strong-caribou branch September 19, 2023 18:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@github-team-consul-core-pr-approver github-team-consul-core-pr-approver github-team-consul-core-pr-approver approved these changes

@blake blake Awaiting requested review from blake

Assignees

@blake blake

Labels

pr/dependencies PR specifically updates dependencies of project theme/acls ACL and token generation theme/api Relating to the HTTP API interface theme/cli Flags and documentation for the CLI interface theme/config Relating to Consul Agent configuration, including reloading theme/connect Anything related to Consul Connect, Service Mesh, Side Car Proxies theme/consul-terraform-sync Relating to Consul Terraform Sync and Network Infrastructure Automation theme/contributing Additions and enhancements to community contributing materials theme/envoy/xds Related to Envoy support theme/health-checks Health Check functionality theme/internals Serf, Raft, SWIM, Lifeguard, Anti-Entropy, locking topics theme/telemetry Anything related to telemetry or observability theme/ui Anything related to the UI type/ci Relating to continuous integration (CI) tooling for testing or releases type/docs Documentation needs to be created/updated/clarified

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@hc-github-team-consul-core @github-team-consul-core-pr-approver @blake