-
Notifications
You must be signed in to change notification settings - Fork 49
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
Update NGINX Agent and NGINX One console in Docs #273
Conversation
✅ All required contributors have signed the F5 CLA for this PR. Thank you! |
I have hereby read the F5 CLA and agree to its terms |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
'the' should only be removed when referring to a product. Product components should keep the determiner:
Correct: NGINX Agent; the NGINX Agent service
Incorrect: The NGINX Agent; NGINX Agent service
Hi @lucYang55
|
@lucYang55 I have applied my suggestions to my PR as these are minor and well documented in our style guide.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@lucYang55 thank you for your contribution and work on this!
May I ask -- what prompted your interest? if I understand your GitHub profile, you're also from Oregon State. You're welcome to respond here, to mi.jang@f5.com, or to DM my LinkedIn at https://www.linkedin.com/in/mijang/
Proposed changes
Problem: I addressed issue 228 where the documentation needed updating to adhere to new style guidelines. This involved phrases like NGINX Agent (not "the NGINX Agent") and "NGINX One Console" v "NGINX One console".
Solution: I updated the documents according to the format that was requested for the issue. I updated several instances with the new style convention.
Testing: This was just documentation, so I made sure the documentation format stayed the same.
If this PR addresses an issue on GitHub, ensure that you link to it here:
#228
Checklist
Before merging a pull request, run through this checklist and mark each as complete.
README.md
andCHANGELOG.md