Remove deprecated instructions from NGINX App Protect WAF

[ADubhlaoich]

Overview

As a NGINX App Protect WAF user, I want only instructions for supported platforms, So I can navigate documentation more clearly.

Description

There wasn't a historic strategy or plan for removing instructions for deprecated operating systems with NGINX App Protect WAF. This means that over time, instructions have accumulated for any operating system App Protect WAF has supported at any point at time.

The impact of this is a huge amount of noise on each installation document. There is a lot of redundant information being rendered on parallel instructions for different versions of the same platform, often creating an over-use of tab elements.

If a reader goes to an installation page without context of supported operating systems, they may be mislead into what instructions to use.

Tasks

• Remove deprecated operating system instructions
• Combine parallel instructions for a given platform into one entry
• Rename the entry to be version-agnostic

The "bare metal" NAP v5 installation document can be used as precedent for how this should be done.

Acceptance criteria

• The user only sees instructions for supported operating systems
• The user experiences consistent formatting and layout for each entry
• The user has a similar navigation experience across all deployment types

[ADubhlaoich]

So far, this has been done on the NAP v5 installation documentation for both the NGINX open source and Plus instructions.

A lot of the work was from updating includes, and I suspect there'll be even more of that in the future - the next step is matching those instructions to the air-gapped environment use case also documented in the same file.

From other work I'm highly cognizant of the fact that different use cases for documentation (v4, all Docker-specific instructions) are all formatted, differently, so I might have to keep this ticket open and ongoing as part of the refactoring efforts.

[JTorreG]

@ADubhlaoich I guess the WAF docs revamp resolved this issue. Can it be closed?

[ADubhlaoich]

Yup, it can.