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

Update NGINX Agent and NGINX One console in Docs #273

Merged
merged 8 commits into from
Mar 17, 2025

Conversation

lucYang55
Copy link
Contributor

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.

  • [ x] I have read the contributing guidelines
  • [ x] I have signed the F5 Contributor License Agreement (CLA)
  • [x ] I have rebased my branch onto main
  • [ x] I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
  • [ x] I have ensured that the commit messages adhere to Conventional Commits
  • [ x] I have ensured that documentation content adheres to the style guide
  • If the change involves potentially sensitive changes[^1], I have assessed the possible impact
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • I have ensured that existing tests pass after adding my changes
  • If applicable, I have updated README.md and CHANGELOG.md

@lucYang55 lucYang55 requested a review from a team as a code owner March 11, 2025 19:18
Copy link

github-actions bot commented Mar 11, 2025

✅ All required contributors have signed the F5 CLA for this PR. Thank you!
Posted by the CLA Assistant Lite bot.

@lucYang55
Copy link
Contributor Author

lucYang55 commented Mar 11, 2025

I have hereby read the F5 CLA and agree to its terms

Copy link
Contributor

@JTorreG JTorreG left a 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

@JTorreG JTorreG added product/nginx-one NGINX One Console product/agent NGINX Agent product/nms NGINX Management Suite (EOS product) labels Mar 11, 2025
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 12, 2025
@mjang
Copy link
Contributor

mjang commented Mar 13, 2025

Hi @lucYang55

  • Thanks so much for your work on this!
  • Tip: If you want to accept a group of these suggestions,
    • Scroll to the top of the page
    • Select the Files changed tab
    • With the "Suggested changes" that you agree with, select Add suggestion to batch
    • When you're done, select Commit suggestions. This process can commit dozens of changes, simultaneously!
  • We're not perfect. If you think our style guide did not give clear instructions, you're welcome to suggest changes in a separate pull request

@lucYang55 I have applied my suggestions to my PR as these are minor and well documented in our style guide.
@JTorreG JTorreG self-requested a review March 17, 2025 15:49
Copy link
Contributor

@mjang mjang left a 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/

@mjang mjang merged commit a1fc2a8 into nginx:main Mar 17, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community documentation Improvements or additions to documentation product/agent NGINX Agent product/nginx-one NGINX One Console product/nms NGINX Management Suite (EOS product)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants