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

Add F5 prefix to configuration opening paragraphs, style consistency #5737

Merged
merged 10 commits into from
Jun 13, 2024

Conversation

ADubhlaoich
Copy link
Contributor

@ADubhlaoich ADubhlaoich commented Jun 12, 2024

This commit changes each of the opening paragraphs of the Configuration section to ensure they have the F5 prefixed name for the first instance of NGINX Ingress Controller.

It also includes a large amount of other changes:

  • Relative links
  • Erroneous product names ("the Ingress Controller")
  • Contemporary table formatting
  • Updated and decoupled input/output code blocks
  • Sentence case for page titles and headings
  • Small contextual rewrites
  • Updated links to appropriate tags

A small number of unrelated changes were also included, regarding NGINX App Protect and a small typo in a command line option.
Preview: https://deploy-preview-5737--nginx-kubernetes-ingress.netlify.app/nginx-ingress-controller/

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

Sorry, something went wrong.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
This commit changes each of the opening paragraphs of the Configuration
section to ensure they have the F5 prefixed name for the first instance
of NGINX Ingress Controller.

It also includes a large amount of other changes:

- Relative links
- Erroneous product names ("the Ingress Controller")
- Contemporary table formatting
- Updated and decoupled input/output code blocks
- Sentence case for page titles and headings
- Small contextual rewrites
- Updated links to appropriate tags

A small number of unrelated changes were also included, regarding NGINX
App Protect and a small typo in a command line option.
@ADubhlaoich ADubhlaoich requested review from a team as code owners June 12, 2024 15:00
@github-actions github-actions bot added the documentation Pull requests/issues for documentation label Jun 12, 2024
pre-commit-ci bot and others added 2 commits June 12, 2024 15:00
for more information, see https://pre-commit.ci
@ADubhlaoich
Copy link
Contributor Author

This is the first of a series of PRs that will all address the same types of documentation consistency problems.

I decided I would split this effort into a section by section basis, so that I do not get mangled by merge issues.

@vepatel vepatel self-requested a review June 13, 2024 11:09
ADubhlaoich and others added 4 commits June 13, 2024 13:27
Co-authored-by: Venktesh Shivam Patel <[email protected]>
Signed-off-by: Alan Dooley <[email protected]>
@vepatel vepatel self-requested a review June 13, 2024 14:02
@ADubhlaoich ADubhlaoich merged commit 0057193 into main Jun 13, 2024
28 checks passed
@ADubhlaoich ADubhlaoich deleted the f5-product-naming branch June 13, 2024 14:44
pdabelf5 pushed a commit that referenced this pull request Jun 17, 2024
…5737)

Add F5 prefix to configuration opening paragraphs, style consistency

This commit changes each of the opening paragraphs of the Configuration
section to ensure they have the F5 prefixed name for the first instance
of NGINX Ingress Controller.

It also includes a large amount of other changes:

- Relative links
- Erroneous product names ("the Ingress Controller")
- Contemporary table formatting
- Updated and decoupled input/output code blocks
- Sentence case for page titles and headings
- Small contextual rewrites
- Updated links to appropriate tags

A small number of unrelated changes were also included, regarding NGINX
App Protect and a small typo in a command line option.

Signed-off-by: Alan Dooley <[email protected]>
Co-authored-by: Venktesh Shivam Patel <[email protected]>
ssrahul96 pushed a commit to ssrahul96/kubernetes-ingress that referenced this pull request Jun 20, 2024
…ginx#5737)

Add F5 prefix to configuration opening paragraphs, style consistency

This commit changes each of the opening paragraphs of the Configuration
section to ensure they have the F5 prefixed name for the first instance
of NGINX Ingress Controller.

It also includes a large amount of other changes:

- Relative links
- Erroneous product names ("the Ingress Controller")
- Contemporary table formatting
- Updated and decoupled input/output code blocks
- Sentence case for page titles and headings
- Small contextual rewrites
- Updated links to appropriate tags

A small number of unrelated changes were also included, regarding NGINX
App Protect and a small typo in a command line option.

Signed-off-by: Alan Dooley <[email protected]>
Co-authored-by: Venktesh Shivam Patel <[email protected]>
ADubhlaoich added a commit that referenced this pull request Aug 23, 2024
…5737)

Add F5 prefix to configuration opening paragraphs, style consistency

This commit changes each of the opening paragraphs of the Configuration
section to ensure they have the F5 prefixed name for the first instance
of NGINX Ingress Controller.

It also includes a large amount of other changes:

- Relative links
- Erroneous product names ("the Ingress Controller")
- Contemporary table formatting
- Updated and decoupled input/output code blocks
- Sentence case for page titles and headings
- Small contextual rewrites
- Updated links to appropriate tags

A small number of unrelated changes were also included, regarding NGINX
App Protect and a small typo in a command line option.

Signed-off-by: Alan Dooley <[email protected]>
Co-authored-by: Venktesh Shivam Patel <[email protected]>
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
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

3 participants