Skip to content

Create an Overview page for NGINX WAF #882

@ADubhlaoich

Description

@ADubhlaoich

Overview

As a user, *I want an overview page of NGINX WAF, So I can understand what it is capable of.

Description

The existing NGINX App Protect WAF documentation doesn't have a singular concept page which describes what the product does.

You can figure it out from context by reading the descriptions of its features or by going to F5's website.

Ideally, we would like a basic description of the product available to the users from the moment they reach the landing page, with additional information from an easily accessible page.

Outside of describing what NGINX WAF does, the same page can also be used to describe the different form factors available for deployment, which should provide the reader meaningful clarity compared to the prior v4 and v5 split.

Tasks

  • Create an Overview page
  • Write or adapt a description of NGINX WAF
  • Ensure there is clarity about differences in deployment/form-factor
  • Guide the user towards "adoption" documentation (Install/deploy) based on their need

There may be overlapping priorities with a Get started/Quickstart guide for this page.

Acceptance criteria

  • The user understands what NGINX WAF is capable of
  • The user understands the nuances of the possible deployment types
  • The user has clear links to next steps: to begin set-up, or explore specific functionality

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions