Keep project name display aligned

[guessi]

What this PR does / why we need it:

To keep project name display aligned across all documentations.

** To keep minimal risk of change, the PR will focus on *.md files only.

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• CVE Report (Scanner found CVE and adding report)
• Breaking change (fix or feature that would cause existing functionality to change)
• Documentation only

Which issue/s this PR fixes

Please refer to #9918 for more details.

How Has This Been Tested?

n/a

Checklist:

• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I've read the CONTRIBUTION guide
• I have added unit and/or e2e tests to cover my changes.
• All new and existing tests passed.
• Added Release Notes.

Does my pull request need a release note?

No

[k8s-ci-robot]

This issue is currently awaiting triage.

If Ingress contributors determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

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]

Welcome @guessi!

It looks like this is your first PR to kubernetes/ingress-nginx 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/ingress-nginx has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

[k8s-ci-robot]

Hi @guessi. 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.

[longwuyuan]

@guessi thanks for the contribution

• I think Project Title change also is ok
• I think you need not touch changelog files as it is a log of changes
• The README inside the charts directory is autogenerated using helm-docs https://github.com/kubernetes/ingress-nginx/blob/main/MANUAL_RELEASE.md#d-edit-the-valuesyaml-and-run-helm-docs

[guessi]

This is the only non-md update in this PR.

I believe it should be the title of the Project Homepage, should be aligned as well.

[guessi]

@longwuyuan I've reverted the changes to Changelog.md as requested. Please review the changes again, thanks!

[longwuyuan]

@guessi please ceck my comment earlier about the README inside the carts directory

[guessi]

@longwuyuan I've updated the charts/* but it seems like failed with unrelated test cases. Please review while you are free, thanks!

[longwuyuan]

@guessi can you leave the /charts directory out of the PR for now. We can add it after the tests pass. Te flaking tests are a known issue so please remember to keep rebasing if main head gets ahead.

[guessi]

Sure, no problem, will update in minutes.

[longwuyuan]

later when you do want to change the README under /charts, please read the link I posted earlier about helm-docs tool. It means you have to edit the values yaml and use the helm docs tools to generate the README file. That file is not to be edited manually

[guessi]

Just updated, I removed the changes to charts/*.

Actually, I do follow the instructions to update values.yaml only. Here's what I did,

$ vim charts/ingress-nginx/values.yaml
$ vim charts/ingress-nginx/README.md.gotmpl # <---- Is this the issue?
$ helm-docs ...
$ git diff --exit-code
$ git add charts/*
$ git commit ...

but I have no idea why it still failed.

[guessi]

For what I see, most recent PRs are all now failing at the same check items, I believe there might have something went wrong before the PR created. Anyway... I've removed all the changes to charts/*, let's see what would happen.

[longwuyuan]

Thanks @guessi
/ok-to-test

[longwuyuan]

/triage-accepted
/kind documentation
/lgtm

[longwuyuan]

@strongjz @rikatz seeking review+lgtm+approved on this small improvement to docs

[strongjz]

/lgtm

Thank you for this.

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: guessi, longwuyuan, strongjz

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:

• OWNERS [strongjz]

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

[guessi]

Thanks for merging this. One quick question, should I create a new PR for charts/* or maybe you guys would do that?

Let me know what I could helps.

[longwuyuan]

@guessi try new PR for /charts/* . You would need to edit values.yaml and then use helm-docs. Ask questions in the dev channel if tests fail