Skip to content

Copy edit to NIM NAP WAF docs #441

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 3 commits into from
Apr 23, 2025

Conversation

travisamartin
Copy link
Contributor

@travisamartin travisamartin commented Apr 22, 2025

Proposed changes

This PR:

  • Expires the WAF Configuration Management topic
  • Renames the following topics
    • NGINX App Protect WAF configuration management --> How WAF policy management works
    • Manage Your App Protect WAF Configs --> Set up WAF configuration management
    • Manage WAF Security Policies and Security Log Profiles --> Manage and deploy WAF policies and log profiles
  • Copy edits for style, audience, and reading level

@github-actions github-actions bot added documentation Improvements or additions to documentation product/nim NGINX Instance Manager product/agent NGINX Agent labels Apr 22, 2025
@travisamartin travisamartin marked this pull request as ready for review April 22, 2025 22:41
@travisamartin travisamartin requested a review from a team as a code owner April 22, 2025 22:41
Copy link

Deploy Preview will be available once build job completes!

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

@travisamartin travisamartin force-pushed the doc433-expire-waf-config-mgmt-index branch from 691cdc2 to 2d46a41 Compare April 22, 2025 22:43
@travisamartin travisamartin force-pushed the doc433-expire-waf-config-mgmt-index branch from 2d46a41 to e6125fe Compare April 23, 2025 00:10
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.

Love it! (I've added some minor comments for consistency)

For future discussion, should we think about harmonizing terms between NIM and N1C, such as

NIM "Instance Groups" ~ N1C "Config Sync Groups"

@mjang
Copy link
Contributor

mjang commented Apr 23, 2025

I did a Vale-based Flesch-Kincaid comparison for the manage-waf-security-policies.md file

Before (current main): 9.51
After (with this PR): 7.45

@travisamartin travisamartin merged commit 3e88395 into main Apr 23, 2025
8 checks passed
@travisamartin travisamartin deleted the doc433-expire-waf-config-mgmt-index branch April 23, 2025 19:43
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 product/agent NGINX Agent product/nim NGINX Instance Manager
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants