Skip to content

NAP DoS 4.9 edit pass#1905

Merged
travisamartin merged 17 commits intonap-dos-4.9from
nap-dos-4.9-edit-pass
May 7, 2026
Merged

NAP DoS 4.9 edit pass#1905
travisamartin merged 17 commits intonap-dos-4.9from
nap-dos-4.9-edit-pass

Conversation

@travisamartin
Copy link
Copy Markdown
Contributor

@travisamartin travisamartin commented Apr 30, 2026

Summary

Editorial pass on files introduced or updated in the nap-dos-4.9 PR. No technical content has been changed.

Changes

  • Product naming: App Protect DoS, NGINX App Protect DoS, F5 DOS for NGINXF5 DoS for NGINX throughout
  • Metadata: Added missing description, keywords, and nd-content-type front matter; corrected nd-product and nd-files in all include files; removed invalid nd-docs: null
  • Acronyms: Expanded eBPF, mTLS, XFF, and ELK on first prose mention; reverted incorrect expansions of FQDN and JWT (both on the common acronyms exempt list)
  • Prose: Removed first-person voice, weak lead sentences, and benefit-selling copy; fixed ClickSelect, i.e.for example, In order toTo, Bugs fixingBug fixes, and similar style issues; removed inline HTML (<br>, <span>) in favour of Markdown
  • Links: Replaced hard-coded docs.nginx.com URLs with {{< ref >}} shortcodes; fixed a broken ref in license-secret.md pointing to a file that was reorganised into a subdirectory
  • Sensitive information: Replaced internal IP 10.197.30.219 (and typo variant 10.97.30.219) with <SYSLOG_SERVER_IP> placeholder per sensitive-information.md

Type of change

  • Editorial / style improvement
  • Technical content change
  • New content

- Fix product names throughout: 'App Protect DoS' and 'F5 DOS for NGINX'
  replaced with correct 'F5 DoS for NGINX'
- Fix 'pre-requisites' → 'prerequisites', '(Purchased or trial)' → lowercase
- Remove first-person voice ('We will configure')
- Replace 'i.e.' with 'for example' throughout
- Fix grammar: 'Bugs fixing' → 'Bug fixes', 'prob.' → 'probe', 'its' → 'it is'
- Replace inline HTML (<br>, <span style=...>) with Markdown equivalents
- Replace hard-coded external links with internal ref shortcodes
- Fix 'Click' → 'Select' per style guide
- Fix heading levels: # Overview → ## Overview in license-secret.md
- Remove weak lead sentence ('This document explains...')
- Fix 'cannot' (was 'can not'), add missing Oxford comma
- Clean up trailing <br> tags from end-of-sentence positions
- Fix double space before 'In offline environments'
@travisamartin travisamartin requested a review from rnitzan April 30, 2026 18:39
@travisamartin travisamartin requested a review from a team as a code owner April 30, 2026 18:39
@github-actions github-actions Bot added documentation Improvements or additions to documentation product/dos Issues related to F5 DoS for NGINX product/nic Issues related to NGINX Ingress Controller product/nginx-one-console Issues related to NGINX One Console labels Apr 30, 2026
…issues

- types-of-logs.md: rewrite Request Log section (missed in previous pass) —
  fix 'App Protect DoS' x3, 'In order to', heading capitalisation, <br> tags
- installing...aws.md: remove last <span> HTML tag in step 4
- learn-about-deployment.md: fix remaining 'App Protect DoS' product name
- troubleshoot.md: expand XFF (X-Forwarded-For); expand ELK on first mention
- kubernetes-with-L4...md: expand eBPF (Extended Berkeley Packet Filter) on
  first mention in prose
- dos-arbitrator.md: expand FQDN (fully qualified domain name); expand mTLS
  (mutual TLS) on first mention
- learn-about-directives-and-policy.md: expand FQDN on first prose mention
The /solutions/about-subscription-licenses.md file was reorganized into
a subdirectory. Update the ref to the correct path and anchor:
/solutions/about-subscription-licenses/getting-started.md#internet-connected
- Add nd-product: F5DOSN to dos-arbitrator.md and install-post-checks.md
- Add missing learn-about-deployment.md to dos-arbitrator.md nd-files list
- Remove invalid nd-docs: null from both files
…dos includes

- Add nd-product: F5DOSN to all includes missing it
- Add nd-files lists based on actual include usage in content files
- Remove invalid nd-docs: null from dos-entrypoint.md and dos-waf-entrypoint.md
- Fix dos-waf-entrypoint.md nd-files: only used in learn-about-deployment.md
- k8s_arbitrator files: nd-product only (not yet referenced in content)
- Replace hardcoded syslog IP 10.197.30.219:5261 with <syslog-server-ip>:<port>
  placeholder in k8s_manifest and k8s_with_ebpf_manifest nginx-conf-configmap files
Comment thread content/includes/dos/dockerfiles/debian-ebpf-manager.md Outdated
Replace non-RFC-5737 example IP 10.197.30.219 (and typo 10.97.30.219)
with <SYSLOG_SERVER_IP> placeholder per sensitive-information.md guidance.

Affected files:
- content/includes/dos/k8s_manifest/dos-nginx-conf-configmap.md
- content/includes/dos/k8s_with_ebpf_manifest/dos-nginx-conf-configmap.md
- content/nap-dos/deployment-guide/best-practices.md (2 occurrences)
Comment thread content/includes/dos/k8s_arbitrator/appprotect-dos-arb.md Outdated
Comment thread content/includes/dos/k8s_arbitrator/svc-appprotect-dos-arb.md Outdated
@travisamartin travisamartin mentioned this pull request Apr 30, 2026
5 tasks
@travisamartin travisamartin requested review from JTorreG and mjang April 30, 2026 22:56
@github-actions
Copy link
Copy Markdown

Deploy Preview will be available once build job completes!

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

travisamartin and others added 4 commits May 1, 2026 07:09
The appprotect-dos-arb.md and svc-appprotect-dos-arb.md include files
in content/includes/dos/k8s_arbitrator/ are not referenced by any
page via the include shortcode, so they serve no purpose.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Remove the 'Use Helm to install' sections from kubernetes.md and
  kubernetes-with-L4-accelerated-mitigation.md; only the manifest-based
  install path remains
- Update front matter (description, keywords, nd-summary) to drop all
  Helm references in both files
- Rename kubernetes-with-L4-accelerated-mitigation..md (double dot) to
  kubernetes-with-L4-accelerated-mitigation.md (single dot)
- Update nd-files references in 18 include files under
  content/includes/dos/ to point to the corrected filename

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@rnitzan
Copy link
Copy Markdown
Contributor

rnitzan commented May 5, 2026

Hi @travisamartin
Thanks for the findings and the fixes.
Please merge when approved so we can finalize #1863
and see its ready for merge on 13/5/2026 when F5 DoS for NGINX 4.9 is released
Thanks

@travisamartin travisamartin merged commit adf1f0a into nap-dos-4.9 May 7, 2026
6 checks passed
@travisamartin travisamartin deleted the nap-dos-4.9-edit-pass branch May 7, 2026 14:55
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/dos Issues related to F5 DoS for NGINX product/nginx-one-console Issues related to NGINX One Console product/nic Issues related to NGINX Ingress Controller

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants