You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: documentation/proposals/DOP-001.md
+27-3Lines changed: 27 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,10 +15,32 @@ This proposal describes my observations about the NGINX App Protect WAF document
15
15
16
16
It will be shared with stakeholders to challenge or verify certain assumptions and to give the affected teams advance warning, as the changes involved are substantial.
17
17
18
+
For clarity, here is a legend for the diagrams:
19
+
20
+
```mermaid
21
+
---
22
+
title: Diagram legend
23
+
---
24
+
graph
25
+
section[Section]
26
+
page>Page]
27
+
usecase([Use case])
28
+
```
29
+
30
+
- A _section_ is a grouping of pages
31
+
- A _page_ is a single document, made up of one or more use cases
32
+
- A _use case_ is a set of instructions for a specific topic
33
+
34
+
Understanding the relationship between pages and use cases is crticially important to contextualise the impact of how certain pages are currently structured.
35
+
18
36
## Issues identified
19
37
20
38
### Content duplication
21
39
40
+
At the highest level, there is a gigantic amount of duplication from [the landing page](https://docs.nginx.com/nginx-app-protect-waf) to account for the V4/V5 split.
41
+
42
+
To emphasize this duplication, I have illustrated the high level sections, which are identical.
43
+
22
44
```mermaid
23
45
---
24
46
title: NGINX App Protect WAF folders
@@ -61,7 +83,7 @@ graph LR
61
83
v5 --> 5rel
62
84
```
63
85
64
-
At initial glance, this does not seem overly complex aside from the V4/5 split. Most of the content in the respective sections are identical, outside of deployment and v5-specific features.
86
+
At initial glance, this does not seem overly complex outside of deployment and v5-specific features.
65
87
66
88
As it stands, the majority of NAP documentation between the V4 and V5 branches are identical - they have the same pages and same sections.
67
89
@@ -71,7 +93,9 @@ I think the structure reflects an earlier intent for V5/X to completely replace/
71
93
72
94
As a result, humongous amounts of the content is replicated, which lead an over-use of includes.
73
95
74
-
Each "step" through these folders is an additional user interaction when navigating through the sidebar. Focusing on a v4 diagram which includes include the individual pages illustrates some of the highest level differences, as well as the single page folder pattern we avoid.
96
+
Each "step" through these folders is an additional user interaction when navigating through the sidebar.
97
+
98
+
Focusing on a v4 diagram which includes include the individual pages illustrates some of the highest level differences, as well as the single page folder pattern we avoid in other product documentation.
75
99
76
100
```mermaid
77
101
---
@@ -435,7 +459,7 @@ flowchart LR
435
459
436
460
```
437
461
438
-
The documentation related to NGINX App Protect WAF currently stored within the NGINX Ingress Controller documentation set would be migrated to instead be managed and stored within the NGINX App Protect WAF documentation. TheV4/V5 split that created the current state of the documentation's IA was also inherited by NGINX Ingress Controller.
462
+
The documentation related to NGINX App Protect WAF currently stored within the NGINX Ingress Controller documentation set would be migrated to instead be managed and stored within the NGINX App Protect WAF documentation. The V4/V5 split that created the current state of the documentation's IA was also inherited by NGINX Ingress Controller.
439
463
440
464
441
465
### Move Troubleshooting information into contextual pages
0 commit comments