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.

Sign up for GitHub

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

Jump to bottom

DOCS consistent indentation for serviceaccount.annotations #10254

Merged
merged 1 commit into from
Sep 5, 2023
Merged

DOCS consistent indentation for serviceaccount.annotations #10254

merged 1 commit into from
Sep 5, 2023

Conversation

mattclegg
Copy link
Contributor

@mattclegg mattclegg commented Jul 28, 2023 •
edited
Loading

What this PR does / why we need it:

Consistent indentation for serviceaccount.annotations

Types of changes

  • Documentation only

Which issue/s this PR fixes

Fix indentation to be consistent.

How Has This Been Tested?

Rendered locally.

Checklist:

  • I have updated the documentation accordingly.
  • I've read the CONTRIBUTION guide
  • All new and existing tests passed.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jul 28, 2023
@netlify
Copy link

netlify bot commented Jul 28, 2023 •
edited
Loading

✅ Deploy Preview for kubernetes-ingress-nginx ready!

Name Link
🔨 Latest commit 65ab509
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-ingress-nginx/deploys/64c3eb31a428d80008d5ebfc
😎 Deploy Preview https://deploy-preview-10254--kubernetes-ingress-nginx.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Jul 28, 2023
@k8s-ci-robot
Copy link
Contributor

Hi @mattclegg. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added needs-kind Indicates a PR lacks a `kind/foo` label and requires one. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. needs-priority size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jul 28, 2023
@k8s-ci-robot k8s-ci-robot added the area/helm Issues or PRs related to helm charts label Jul 28, 2023
@mattclegg
BUGFIX incorrect indentation
65ab509 
Error: Failed to render chart: exit status 1: Error: YAML parse error on ingress-nginx/templates/controller-serviceaccount.yaml: error converting YAML to JSON: yaml: line 14: mapping values are not allowed in this context
  Use --debug flag to render out invalid YAML
  Error: plugin "diff" exited with error
@mattclegg mattclegg force-pushed the BUGFIX-incorrect-indentation branch from 812cc5d to 65ab509 Compare July 28, 2023 16:22
@longwuyuan
Copy link
Contributor

@mattclegg am I supposed to get the same error if I try this screenshot
image

@mattclegg
Copy link
Contributor Author

mattclegg commented Jul 28, 2023 •
edited
Loading

Ok, the issue was actually fixed earlier but this just makes the annotations yaml consistent with the style used in the rest of the chart.

Thanks @longwuyuan I've updated the PR description.

@mattclegg mattclegg changed the title BUGFIX incorrect indentation for serviceaccount.annotations DOCS consistent indentation for serviceaccount.annotations Aug 2, 2023
@rikatz
Copy link
Contributor

rikatz commented Aug 11, 2023

@longwuyuan can this one be merged? :)

@longwuyuan
Copy link
Contributor

@rikatz No, I could not reproduce the problem this PR is expected to fix

@mattclegg
Copy link
Contributor Author

@longwuyuan The description was updated after your previous comment; now it's just fixing an inconsistency in the yaml.

@longwuyuan
Copy link
Contributor

longwuyuan commented Aug 16, 2023 •
edited
Loading

@mattclegg I am sorry because my comments need to be more clear for all readers and not be a blocker for improvements you have proposed.

Can you help and create an issue that sort of details the problem you are fixing here. then link that issue here (there is a syntax like "fixes", that I know, becomes visible in a new PR template). That should help clarify. Regards and thanks for this contribution. Apologies taking time to merge.

@mattclegg
Copy link
Contributor Author

@longwuyuan It's a minor documentation/indentation change. It's not worth the time creating it as an "issue".

@longwuyuan
Copy link
Contributor

I am so sorry but I am terribly confused.

  • The fileschanged tab above shows that this PR will change a nginx-ingress helm chart template file and not any .md documentation file . So how is this a documentation change

image

  • Secondly, I executed the command helm template and copy/pasted the screenshot to verify if the current template is broken. I could not see where it is broken.
  • Maybe someone else will see that I am wrong and that template is broken for that spec/field. Please wait for that.
  • Alternatively, you can also run the helm template command and copy/paste the broken rendering in a message posting here, so show the problem that is fixed by merging line 14 & line 15 of that helm chart template, as this PR proposes that

Best regards

@mattclegg
Copy link
Contributor Author

Thanks for taking the time to check the PR @longwuyuan

Documentation isn't just about .md files but also the readability of code. I will try to phrase it differently. There are currently 15 instances for;

annotations: {{

But only 1 instance of;

annotations:
{{-

This (trivial) PR updates that 1 instance so the template is consistent.

@longwuyuan
Copy link
Contributor

longwuyuan commented Aug 18, 2023 •
edited
Loading

@mattclegg thnks for your patience and thanks for the contribution.
The last message above from you clarifies the improvement for all readers. Sorry it got delayed so much.
https://github.com/search?q=repo%3Akubernetes%2Fingress-nginx%20annotations%3A%20%7B%7B&type=code

/lgtm

@strongjz @tao12345666333 PTAL

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 18, 2023
@mattclegg
Copy link
Contributor Author

Anything else needed @cpanato ?

cpanato
cpanato approved these changes Sep 5, 2023
View reviewed changes
Copy link
Member

@cpanato cpanato left a comment

Choose a reason for hiding this comment

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

/triage accepted
/kind cleanup
/priority important-soon

/approve

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. labels Sep 5, 2023
@k8s-ci-robot k8s-ci-robot added priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-kind Indicates a PR lacks a `kind/foo` label and requires one. needs-priority labels Sep 5, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: cpanato, longwuyuan, mattclegg

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 Sep 5, 2023
@k8s-ci-robot k8s-ci-robot merged commit c9ca168 into kubernetes:main Sep 5, 2023
40 checks passed
@mattclegg mattclegg deleted the BUGFIX-incorrect-indentation branch September 11, 2023 09:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cpanato cpanato cpanato approved these changes

@strongjz strongjz Awaiting requested review from strongjz

Assignees

@longwuyuan longwuyuan

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/helm Issues or PRs related to helm charts cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@mattclegg @k8s-ci-robot @longwuyuan @rikatz @cpanato