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

Rewrite NGINX App Protect WAF Integration Section #4726

Merged
merged 12 commits into from Dec 13, 2023

Conversation

ADubhlaoich
Copy link
Contributor

@ADubhlaoich ADubhlaoich commented Nov 30, 2023

Proposed changes

This PR rewrites the integration section for NGINX App Protect WAF, finishing the first set of major IA changes for the NGINX Ingress Controller docset. Much of the format and detail comes from the precedent set by work for the DOS section.

Rewrite NGINX App Protect WAF Installation, add deployment include

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.

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.
@ADubhlaoich ADubhlaoich self-assigned this Nov 30, 2023
@ADubhlaoich ADubhlaoich requested review from a team as code owners November 30, 2023 11:47
@ADubhlaoich ADubhlaoich marked this pull request as draft November 30, 2023 11:47
@github-actions github-actions bot added the documentation Pull requests/issues for documentation label Nov 30, 2023
@ADubhlaoich ADubhlaoich changed the title Rewrite NGINX App Protect WAF Installation, add deployment include Rewrite NGINX App Protect WAF Integration Section Nov 30, 2023
Copy link

codecov bot commented Nov 30, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (dd2c994) 52.01% compared to head (a14fe04) 52.01%.

❗ Current head a14fe04 differs from pull request most recent head 9542415. Consider uploading reports for the commit 9542415 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4726   +/-   ##
=======================================
  Coverage   52.01%   52.01%           
=======================================
  Files          60       60           
  Lines       17313    17313           
=======================================
  Hits         9005     9005           
  Misses       7995     7995           
  Partials      313      313           

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

ADubhlaoich and others added 5 commits December 5, 2023 16:56
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 arej also included to rephrase sections of
the configuration document for conciseness and clarity.
@ADubhlaoich ADubhlaoich marked this pull request as ready for review December 13, 2023 11:14
@ADubhlaoich ADubhlaoich enabled auto-merge (squash) December 13, 2023 11:28
@ADubhlaoich ADubhlaoich enabled auto-merge (squash) December 13, 2023 12:13
…ifests.md

Signed-off-by: Alan Dooley <ADubhlaoich@users.noreply.github.com>
@ADubhlaoich ADubhlaoich merged commit 6013e57 into main Dec 13, 2023
40 of 41 checks passed
@ADubhlaoich ADubhlaoich deleted the revamp-app-protect-section branch December 13, 2023 17:03
ADubhlaoich added a commit to ADubhlaoich/nic-doc-work that referenced this pull request Dec 27, 2023
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.
ADubhlaoich added a commit to ADubhlaoich/nic-doc-work that referenced this pull request Dec 27, 2023
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.
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
Status: Done 🚀
Development

Successfully merging this pull request may close these issues.

None yet

3 participants