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

Updates to pull-ingress-controller-image doc #2530

Merged
merged 2 commits into from Mar 23, 2022
Merged

Conversation

jputrino
Copy link
Contributor

@jputrino jputrino commented Mar 23, 2022

  • 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

Note: I'm not sure why the netlify build isn't running for this PR, but I did build the docs locally. I verified that the links work and that everything renders ok.

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 master
  • I will ensure my PR is targeting the master branch and pulling from my branch from my own fork

@jputrino jputrino marked this pull request as ready for review March 23, 2022 16:41
@jputrino jputrino added the documentation Pull requests/issues for documentation label Mar 23, 2022
- 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
Co-authored-by: Luca Comellini <luca.com@gmail.com>
@jputrino jputrino enabled auto-merge (rebase) March 23, 2022 17:35
@lucacome lucacome disabled auto-merge March 23, 2022 17:43
@lucacome lucacome merged commit 6ca56c6 into master Mar 23, 2022
@lucacome lucacome deleted the fix-typo-pull-image branch March 23, 2022 17:44
jputrino added a commit that referenced this pull request Mar 23, 2022
- 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
lucacome pushed a commit that referenced this pull request Mar 23, 2022
…ranch (#2530) (#2531)

- 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
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

3 participants