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

docs: Revise Security Monitoring guides and remove outdated install g… #86

Closed

Conversation

travisamartin
Copy link
Contributor

@travisamartin travisamartin commented Jan 22, 2025

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

  • Updated "Create App Protect WAF instance for Security Monitoring," "Add user access to Security Monitoring dashboard," "Update the Attack Signature Database," "Update the Geolocation Database," and "Troubleshooting" guides for readability and accuracy.
  • Removed the outdated Security Monitoring installation guide.

Why

Improves usability, reflects current product behavior, and enhances global accessibility.

Copy link
Contributor

@mkingst mkingst left a comment

Choose a reason for hiding this comment

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

Looks good to me! Do you think we should mention something about Security Monitoring in the following section:

image

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.

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.

Copy link
Contributor

@mjang mjang left a 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)

Copy link

Deploy Preview will be available once build job completes!

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

@travisamartin travisamartin force-pushed the docs-1604-decouple-security-monitoring branch from 9b24c70 to 6c61ec1 Compare January 22, 2025 15:14
@travisamartin travisamartin requested a review from mjang January 22, 2025 15:14
Copy link
Contributor

@mjang mjang left a 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

@jputrino
Copy link
Contributor

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.

@mkingst
Copy link
Contributor

mkingst commented Jan 22, 2025

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.

This is where Security Monitoring is going in the NIM UI, so I agree..

image

@travisamartin
Copy link
Contributor Author

Moved to docs repo.

@travisamartin travisamartin deleted the docs-1604-decouple-security-monitoring branch January 30, 2025 18:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants