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

Cherry-pick updates to pull-ingress-controller-image doc to release branch (#2530) #2531

Merged
merged 1 commit into from Mar 23, 2022

Conversation

jputrino
Copy link
Contributor

Cherry-pick from main: 6ca56c6

  • Fix broken links reported by field
  • Update link target text so that instead of using "here", they have descriptions of the target documents. This is especially important when linking out to external locations (like the Docker docs)
  • Use hugo relref for internal doc links -- when these are used, hugo build will fail if the link is broken
  • Change "e.g." to "for example" -- brings us into compliance with internal style guide

Proposed changes

Describe the use case and detail of the change. If this PR addresses an issue on GitHub, make sure to include a link to that issue here in this description (not in the title of the PR).

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

- Fix broken links reported by field
- Update link target text so that instead of using "here", they have descriptions of the target documents. This is especially important when linking out to external locations (like the Docker docs)
- Use hugo `relref` for internal doc links -- when these are used, hugo build will fail if the link is broken
- Change "e.g." to "for example" -- brings us into compliance with internal style guide
@github-actions github-actions bot added the documentation Pull requests/issues for documentation label Mar 23, 2022
@lucacome lucacome requested review from a team, lucacome, haywoodsh and jjngx March 23, 2022 19:03
@lucacome lucacome merged commit a9981a3 into release-2.1 Mar 23, 2022
@lucacome lucacome deleted the cherry-pick-6ca56c60 branch March 23, 2022 22:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Pull requests/issues for documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants