Skip to content

Update product titles in one.json #521

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Kkresge
Copy link

@Kkresge Kkresge commented May 4, 2025

#228

Proposed changes

Problem: Inconsistent case used for the product titled "NGINX One Console"

Solution: Changed all instances of "NGINX One console" to "NGINX One Console"

Testing: None

If this PR addresses an issue on GitHub, ensure that you link to it here:

Closes #228

Checklist

Before merging a pull request, run through this checklist and mark each as complete.

  • I have read the contributing guidelines
  • I have signed the F5 Contributor License Agreement (CLA)
  • I have rebased my branch onto main
  • I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
  • I have ensured that the commit messages adhere to Conventional Commits
  • I have ensured that documentation content adheres to the style guide
  • If the change involves potentially sensitive changes1, 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

Footnotes

  1. Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. Please refer to our style guide for guidance about placeholder content.

@Kkresge Kkresge requested a review from a team as a code owner May 4, 2025 23:02
@github-actions github-actions bot added the documentation Improvements or additions to documentation label May 4, 2025
Copy link

github-actions bot commented May 4, 2025

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

@Kkresge
Copy link
Author

Kkresge commented May 4, 2025

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

@mjang
Copy link
Contributor

mjang commented May 5, 2025

Hi @Kkresge

Thank you for your contribution!

You've found an interesting file, a key to API documentation. There are a few things I should explain about it. Short version, to fix these titles, I'm going to have to change some "YAML" files from a different repository that's not open to the public. (I'm moving this to "draft" to prevent accidental merge.)

If you have some time while we're at the conference, I'd love to show you how we "build" this one.json file from other content -- and how that builds API docs. But you might already know that, as it takes quite the detective to find this file!

If you don't see me, DM me -- I'm @mikejang on the Write the Docs Slack

Note: as you can see, I've created issue #523 from your contribution. We will address it!

@mjang mjang marked this pull request as draft May 5, 2025 14:41
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
None yet
Development

Successfully merging this pull request may close these issues.

Updates to product titles based on style updates
2 participants