-
Notifications
You must be signed in to change notification settings - Fork 2k
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
Conversation
✅ Deploy Preview will be available once build job completes!
|
I didn't realize this was already on the roadmap. |
I've been told that we're not yet ready for this. We're currently working on integration with NAP. |
Is there a Jira/GitHub issue that you've been working from? |
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. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
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. 🚀 New features to boost your workflow:
|
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.
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.
The draft focuses on deployment from the NIC side, but not on the value of integration with NGINX One. Recommendations:
|
@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. |
@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!" |
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.