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 product titles based on style updates #228

Open
mjang opened this issue Feb 25, 2025 · 1 comment
Open

Updates to product titles based on style updates #228

mjang opened this issue Feb 25, 2025 · 1 comment
Labels
bug Something isn't working good first issue Good for newcomers

Comments

@mjang
Copy link
Contributor

mjang commented Feb 25, 2025

Describe the bug

Inconsistent use in our docs. Preferred option first:

  • "NGINX" v "an NGINX" v "a NGINX"
    • ref style guide: "Don't use articles ("the", "a") in front of product names. For example, use NGINX Agent (not "the NGINX Agent")." Link to style guide
  • "NGINX One Console" v "NGINX One console"

Expected behavior

Consistency with style guide

How to find instances with this issue

One method, UI based (you're welcome to use the method of your choice)

  • Navigate to https://github.com/nginx/documentation
  • Near the upper right of the screen, find the text box with Type / to search
  • Enter the problematic term in the search box.
    • Tip: for a case sensitive search, such as for "NGINX One console", enter:
    • /(?-i)NGINX One console/
      • Do not delete the repo:nginx/documentation prefix in the search box
@lucYang55
Copy link
Contributor

Hello I would love to participate in this

lucYang55 added a commit to lucYang55/documentation that referenced this issue Mar 11, 2025
lucYang55 added a commit to lucYang55/documentation that referenced this issue Mar 11, 2025
lucYang55 added a commit to lucYang55/documentation that referenced this issue Mar 11, 2025
mjang added a commit that referenced this issue Mar 17, 2025
* Updated documentation for create-manage-data-plane-keys to follow new style updates per issue #228

* Updated documentation for configure-nginx-agent-group.md to follow new style updates per issue #228

* Updated documentation for install-nginx-agent.md to follow new style updates per issue #228

* Apply suggestions from code review

@lucYang55 I have applied my suggestions to my PR as these are minor and well documented in our style guide.

---------

Co-authored-by: Mike Jang <[email protected]>
Co-authored-by: Jon Torre <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants