Skip to content

Docs for connecting NIC to NGINX One Console #7815

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

Merged
merged 14 commits into from
May 30, 2025
Merged

Docs for connecting NIC to NGINX One Console #7815

merged 14 commits into from
May 30, 2025

Conversation

AlexFenlon
Copy link
Contributor

@AlexFenlon AlexFenlon commented May 20, 2025

Proposed changes

Docs for connecting NGINX Ingress Controller to NGINX One Console

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

@AlexFenlon AlexFenlon requested review from a team as code owners May 20, 2025 16:00
@github-actions github-actions bot added the documentation Pull requests/issues for documentation label May 20, 2025
Copy link

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/nginx-ingress-controller/7815/

jjngx
jjngx previously approved these changes May 20, 2025
pdabelf5
pdabelf5 previously approved these changes May 20, 2025
@mjang
Copy link
Contributor

mjang commented May 20, 2025

cc @jasonclopper

I didn't realize this was already on the roadmap.

vepatel
vepatel previously approved these changes May 20, 2025
@mjang
Copy link
Contributor

mjang commented May 20, 2025

I've been told that we're not yet ready for this. We're currently working on integration with NAP.

@mjang
Copy link
Contributor

mjang commented May 20, 2025

Is there a Jira/GitHub issue that you've been working from?

@jputrino
Copy link
Contributor

Please hold off on this. @shaun-nx & @jasonclopper -- We need to sync up on the approach to documenting this use case. NIC does not exist in a vacuum, nor should the docs for an integrated use case such as this.

@AlexFenlon AlexFenlon moved this from Todo ☑ to In Review 👀 in NGINX Ingress Controller May 21, 2025
@AlexFenlon AlexFenlon self-assigned this May 21, 2025
@AlexFenlon AlexFenlon changed the title Docs for connecting NIC to NGINX One SaaS Console Docs for connecting NIC to NGINX One Console May 21, 2025
@AlexFenlon AlexFenlon dismissed stale reviews from vepatel, pdabelf5, and jjngx via 4b1275d May 21, 2025 08:42
@AlexFenlon AlexFenlon marked this pull request as draft May 22, 2025 11:10
Copy link

codecov bot commented May 22, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 52.28%. Comparing base (38094d2) to head (ce07302).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #7815      +/-   ##
==========================================
- Coverage   52.30%   52.28%   -0.02%     
==========================================
  Files          90       90              
  Lines       21472    21472              
==========================================
- Hits        11231    11227       -4     
- Misses       9772     9774       +2     
- Partials      469      471       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@AlexFenlon AlexFenlon requested a review from ADubhlaoich May 26, 2025 10:34
ADubhlaoich
ADubhlaoich previously approved these changes May 26, 2025
Copy link
Contributor

@ADubhlaoich ADubhlaoich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally LGTM: please take a look at my earlier edit suggestion for the frontmatter data.

Adjusting indentation of codeblocks in GitHub suggestions seems to also be parsed very oddly.

@travisamartin
Copy link
Contributor

travisamartin commented May 27, 2025

The draft focuses on deployment from the NIC side, but not on the value of integration with NGINX One.
NGINX One should be the hero of the story — not the sidekick.

Recommendations:

  • Reframe from the perspective of NGINX One; open with the benefits of this integration: central monitoring, visibility, operational efficiency.
  • Make this doc discoverable through both the N1 and NIC content sets, but maintain one canonical version in N1.

@ADubhlaoich
Copy link
Contributor

@travisamartin I'll bring this up during the internal meeting this week about it: I recommend we merge this doc as-is (With the important caveat that it retains the draft parameter), and update this for tone/consistency with N1C as part of content planning for full feature implementation.

NIC documentation is due to be migrated into the main documentation repository, which this PR is blocking, and once it has been migrated, it'll be very easy to transform this document however necessary.

@travisamartin
Copy link
Contributor

@ADubhlaoich -- Please work w/ @mjang on placement for the N1 integration docs. We want to minimize hops between docs, and prioritize N1 as a point of entry in the user journey.

Additionally, the doc should end with a "What's next" section to guide the user toward additional "value adds." "Now that you're integrated, check out these useful things you can do!"

@AlexFenlon AlexFenlon marked this pull request as ready for review May 30, 2025 10:09
@AlexFenlon AlexFenlon enabled auto-merge (squash) May 30, 2025 10:09
@AlexFenlon AlexFenlon merged commit 73c6744 into main May 30, 2025
30 checks passed
@AlexFenlon AlexFenlon deleted the docs/agent-v3 branch May 30, 2025 11:00
@github-project-automation github-project-automation bot moved this from In Review 👀 to Done 🚀 in NGINX Ingress Controller May 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Pull requests/issues for documentation
Projects
Status: Done 🚀
Development

Successfully merging this pull request may close these issues.

9 participants