-
Notifications
You must be signed in to change notification settings - Fork 20
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
docs: Revise Security Monitoring guides and remove outdated install g… #86
docs: Revise Security Monitoring guides and remove outdated install g… #86
Conversation
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.
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.
LGTM!
I've a few edit suggestions for frontmatter consistency: toc
is optional, whereas every single document should have title
and weight
, so I put them before everything else.
content/nim/monitoring/security-monitoring/give-access-to-security-monitoring-dashboards.md
Outdated
Show resolved
Hide resolved
content/nim/monitoring/security-monitoring/update-signatures.md
Outdated
Show resolved
Hide resolved
content/nim/monitoring/security-monitoring/set-up-app-protect-instances.md
Outdated
Show resolved
Hide resolved
content/nim/monitoring/security-monitoring/give-access-to-security-monitoring-dashboards.md
Outdated
Show resolved
Hide resolved
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.
I did a make watch
to build these docs, and I got this error:
ERROR [en] REF_NOT_FOUND: Ref "create-role-security-monitoring": "/Users/mi.jang/Repos/documentation/content/nim/monitoring/security-monitoring/set-up-app-protect-instances.md:191:62": page not found
which corresponds to this line.
(The error also shows up in the failed check, ref https://github.com/nginx/documentation/actions/runs/12898553974/job/35965840197?pr=86#step:12:32)
✅ Deploy Preview will be available once build job completes!
|
…uide
9b24c70
to
6c61ec1
Compare
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.
I see that the build issue is now fixed
I'm wondering if it makes more sense to nest these docs under nim/nginx-app-protect than under monitoring. Having docs that deal with using NAP with NIM in 2 different places could be confusing to users. |
…04-decouple-security-monitoring
Moved to docs repo. |
Proposed changes
This PR updates the Security Monitoring module documentation for clarity, consistency, and alignment with F5 Modern Voice and NGINX style guidelines. It also removes the outdated installation guide since the module is now installed with NGINX Instance Manager (NIM).
Changes
Why
Improves usability, reflects current product behavior, and enhances global accessibility.