Proposal: Refactoring NGINX App Protect WAF documentation #547
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit adds a new documentation folder to the repository, with a discrete section for proposals. I will be using this folder in the future to organise more process documentation. NGINX App Protect WAF has had a lot of fundamental design problems with how its documentation is structured due to historic changes in the direction of the product. Since those changes, the documentation has not changed to account for it.
…tation into docs/nap-refactor-proposal
…tation into docs/nap-refactor-proposal
✅ Deploy Preview will be available once build job completes!
|
|
It occurs to me now that I've thrown this PR up, I could have done a partial refactor as a proof of concept that could be interacted with as a Deployment preview. I'm not certain the time investment would be useful to exemplify the point, however, and the full extent of changes involved with a refactor mean it's difficult to isolate one set of changes given the amount of reference links that need to be updated. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
This pull request is the living document for a proposal to refactor the NGINX App Protect WAF documentation.
For ease of review, please view the file directly, which will render the diagrams properly.
Feedback should be added parts of the proposal using GitHub's commenting feature.
Checklist
Before merging a pull request, run through this checklist and mark each as complete.
README.mdandCHANGELOG.mdFootnotes
Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. Please refer to our style guide for guidance about placeholder content. ↩