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

Cherry-pick NGINX App Protect WAF & VirtualServer documentation changes #4844

Merged

Conversation

ADubhlaoich
Copy link
Contributor

@ADubhlaoich ADubhlaoich commented Dec 27, 2023

Proposed changes

This PR cherry-picks two commits from the main branch: the first is a set of changes for the NGINX App Protect WAF integration and the other is to fix a broken link in a VirtualServer tutorial (And updating others at the same time).

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

This commit rewrites the installation document for NGINX App Protect WAF
to match the format posited in the prior NGINX App Protect DOS rewrite.
As part of the changes, a snippet of text indicating the deployment options
for NGINX Ingress Controller was turned into an include.

This commit adds a new include file for custom resources, and
subsequently adds it to the relevant App Protect WAF/DoS documentation.

A few documentation improvements are also included to rephrase sections of
the configuration document for conciseness and clarity.
This commit fixes a broken link in the VirtualServer tutorial for custom
ports that was intended to point at the repository's example folder.
While addressing this change, I also updated the other links to become
relative references to avoid other issues.
@ADubhlaoich ADubhlaoich self-assigned this Dec 27, 2023
@ADubhlaoich ADubhlaoich requested review from a team as code owners December 27, 2023 13:25
Copy link

netlify bot commented Dec 27, 2023

👷 Deploy request for nginx-kubernetes-ingress accepted.

Name Link
🔨 Latest commit acb4bab
🔍 Latest deploy log https://app.netlify.com/sites/nginx-kubernetes-ingress/deploys/658c25be01902400088bbbf0

@github-actions github-actions bot added the documentation Pull requests/issues for documentation label Dec 27, 2023
@ADubhlaoich ADubhlaoich enabled auto-merge (squash) December 27, 2023 13:26
Copy link

codecov bot commented Dec 27, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (dd82122) 52.03% compared to head (acb4bab) 52.01%.

Additional details and impacted files
@@               Coverage Diff               @@
##           release-3.4    #4844      +/-   ##
===============================================
- Coverage        52.03%   52.01%   -0.03%     
===============================================
  Files               60       60              
  Lines            17313    17313              
===============================================
- Hits              9009     9005       -4     
- Misses            7993     7995       +2     
- Partials           311      313       +2     

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

@vepatel vepatel requested a review from jjngx December 27, 2023 14:06
@ADubhlaoich ADubhlaoich merged commit f136a4f into nginxinc:release-3.4 Dec 27, 2023
69 checks passed
@ADubhlaoich ADubhlaoich deleted the docs/cp-december-changes branch December 27, 2023 16:13
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
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

3 participants