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

NAP link fixes & improvements to troubleshooting documentation #5605

Merged
merged 2 commits into from
May 23, 2024

Conversation

ADubhlaoich
Copy link
Contributor

@ADubhlaoich ADubhlaoich commented May 22, 2024

Proposed changes

This PR fixes a number of issues related to the documentation for NAP WAF & DoS integrations, closing issue #5567:

  • Outdated links
  • Page ordering
  • Style issues

As part of the work in this PR I also made a small number of changes to Troubleshooting documentation in line with the above style issues:

  • Sentence case over title case
  • Removal of gerunds
  • Phrasing

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

@ADubhlaoich ADubhlaoich self-assigned this May 22, 2024
@ADubhlaoich ADubhlaoich requested review from a team as code owners May 22, 2024 16:11
@ADubhlaoich ADubhlaoich marked this pull request as draft May 22, 2024 16:11
@github-actions github-actions bot added the documentation Pull requests/issues for documentation label May 22, 2024
@ADubhlaoich ADubhlaoich linked an issue May 23, 2024 that may be closed by this pull request
@ADubhlaoich ADubhlaoich marked this pull request as ready for review May 23, 2024 13:27
@ADubhlaoich ADubhlaoich changed the title NAP WAF & DoS Fixes NAP link fixes & improvements to troubleshooting documentation May 23, 2024
@ADubhlaoich ADubhlaoich enabled auto-merge (squash) May 23, 2024 14:07
@ADubhlaoich ADubhlaoich merged commit 5c6fa93 into main May 23, 2024
28 checks passed
@ADubhlaoich ADubhlaoich deleted the update-nap-links branch May 23, 2024 14:18
ADubhlaoich added a commit that referenced this pull request May 29, 2024
This commit updates broken NAP links to include the v4 path and changes
the location of the troubleshooting documents so that they are colocated with
the other NAP documentation.

As part of this effort a number of improvements were made to the WAF, DoS
and troubleshooting documents related to newer documentation standards.
These changes include the use of title case and excision of gerunds.
ssrahul96 pushed a commit to ssrahul96/kubernetes-ingress that referenced this pull request Jun 20, 2024
…inc#5605)

This commit updates broken NAP links to include the v4 path and changes
the location of the troubleshooting documents so that they are colocated with
the other NAP documentation.

As part of this effort a number of improvements were made to the WAF, DoS 
and troubleshooting documents related to newer documentation standards.
These changes include the use of title case and excision of gerunds.
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.

Update AppProtect WAF doc references in NIC docs
3 participants