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

🐛Fix the typo in the json content #5527

Merged
merged 1 commit into from
Oct 28, 2021

Conversation

mkumatag
Copy link
Member

@mkumatag mkumatag commented Oct 28, 2021

What this PR does / why we need it:

Currently, there is an error in the JSON text mentioned in the developers' guide which needs to be fixed. As per json standard, there is no trailing comma is supported.

e.g:

$ echo '
{
  "name": "infrastructure-aws",
  "config": {
    "componentsFile": "infrastructure-components.yaml",
    "nextVersion": "v0.5.0",
  }
}
'| jq
parse error: Expected another key-value pair at line 7, column 3

After the fix:

$ echo '                                                                                                                                                                                           4 ↵
{
  "name": "infrastructure-aws",
  "config": {
    "componentsFile": "infrastructure-components.yaml",
    "nextVersion": "v0.5.0"
  }
}
'| jq
{
  "name": "infrastructure-aws",
  "config": {
    "componentsFile": "infrastructure-components.yaml",
    "nextVersion": "v0.5.0"
  }
}

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Oct 28, 2021
@randomvariable
Copy link
Member

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 28, 2021
Copy link
Contributor

@killianmuldoon killianmuldoon left a comment

Choose a reason for hiding this comment

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

Good find!
Is there any way to run linters on our tagged (yaml, json etc.) code blocks in our MD files? There could be a few more surprises like this for users.

/lgtm

@randomvariable
Copy link
Member

randomvariable commented Oct 28, 2021

Is there any way to run linters on our tagged (yaml, json etc.) code blocks in our MD files?

I'm using markdownlint-cli2 in a downstream repository running in a Docker nodejs container. It would be possible to add that here too.

That said, I suspect it wouldn't be able to catch this type of error as it would need support for language parsing/validation for multiple languages.

Copy link
Member

@vincepri vincepri left a comment

Choose a reason for hiding this comment

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

/approve
/lgtm

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vincepri

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 28, 2021
@k8s-ci-robot k8s-ci-robot merged commit f3d4451 into kubernetes-sigs:main Oct 28, 2021
@k8s-ci-robot k8s-ci-robot added this to the v1.1 milestone Oct 28, 2021
@mkumatag mkumatag deleted the fix_typo branch October 28, 2021 14:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants