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

Reduce contextual use of "NGF" three letter acronym #1516

Merged
merged 3 commits into from
Jan 30, 2024

Conversation

ADubhlaoich
Copy link
Contributor

@ADubhlaoich ADubhlaoich commented Jan 30, 2024

Proposed changes

For conciseness, "ngf" is often used as part of the naming conventions for processes, image names and other artefacts. It should be avoided in documentation when referring to the actual software, which this commit addresses in a handful of identified instances.

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

For conciseness, "ngf" is often used as part of the naming conventions
for processes, image names and other artefacts. It should be avoided in
documentation when referring to the actual software, which this commit
addresses in a handful of identified instances.
@ADubhlaoich ADubhlaoich requested review from a team as code owners January 30, 2024 12:42
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 30, 2024
@ADubhlaoich
Copy link
Contributor Author

ADubhlaoich commented Jan 30, 2024

To pre-empt some possible feedback: one of the lines changes an example of a "NGF" TLA while keeping another earlier in the same paragraph. In context, the first use of "NGF" is an instance in the example, while the second instance is referring to the software in a broader sense.

@ADubhlaoich ADubhlaoich enabled auto-merge (squash) January 30, 2024 15:36
@ADubhlaoich ADubhlaoich self-assigned this Jan 30, 2024
@ADubhlaoich ADubhlaoich merged commit 37294b5 into nginxinc:main Jan 30, 2024
27 checks passed
@ADubhlaoich ADubhlaoich deleted the docs/consistency-sweep branch January 30, 2024 17:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants