Skip to content

[Story]: Make F5 WAF for NGINX version strings into pseudovariables #1364

@ADubhlaoich

Description

@ADubhlaoich

Overview

As a user,
I want documentation instructions to install the latest version of F5 WAF for NGINX,
So that I can take advantage of the latest features

As a maintainer,
I want an easy way to update versions of components,
So that it's simpler and quicker to maintain

Which product or products does this request relate to?

F5 WAF for NGINX

Description

We've had a handful of reported instances of users being led astray by documentation because certain instructions have unclear, inconsistent or outdated targets for Docker images and similar build artefacts.

NGINX Ingress Controller and NGINX Gateway Fabric have a pattern where the latest version of the software or Helm chart are controlled by a shortcode used as a pseudo-variable, rendering a text substitution everywhere it is used.

This same pattern could be applied to F5 WAF for NGINX, meaning that the user will always be directed to install the latest versions of software in code examples, and someone working on a release will only need to update a single file per artefact - reducing drift and simplifying maintenance.

Acceptance criteria

  • The user sees the latest version of software in code examples
  • The maintainer can update text in one place to reflect changes everywhere

Metadata

Metadata

Assignees

Labels

🔥 p2Priority 2: Impacts production; non-emergencyproduct/ngfIssues related to NGINX Gateway Fabric

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions