Skip to content

Commit 1563f7a

Browse files
committed
feat: Add legend to proposal, preamble
1 parent b9e0ac2 commit 1563f7a

File tree

1 file changed

+27
-3
lines changed

1 file changed

+27
-3
lines changed

documentation/proposals/DOP-001.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,32 @@ This proposal describes my observations about the NGINX App Protect WAF document
1515

1616
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.
1717

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+
1836
## Issues identified
1937

2038
### Content duplication
2139

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+
2244
```mermaid
2345
---
2446
title: NGINX App Protect WAF folders
@@ -61,7 +83,7 @@ graph LR
6183
v5 --> 5rel
6284
```
6385

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.
6587

6688
As it stands, the majority of NAP documentation between the V4 and V5 branches are identical - they have the same pages and same sections.
6789

@@ -71,7 +93,9 @@ I think the structure reflects an earlier intent for V5/X to completely replace/
7193

7294
As a result, humongous amounts of the content is replicated, which lead an over-use of includes.
7395

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.
7599

76100
```mermaid
77101
---
@@ -435,7 +459,7 @@ flowchart LR
435459
436460
```
437461

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.
439463

440464

441465
### Move Troubleshooting information into contextual pages

0 commit comments

Comments
 (0)