Skip to content

Create a version shortcode for NGINX Gateway Fabric and replace the current hard-coded release versions #199

Closed
@ADubhlaoich

Description

@ADubhlaoich

Overview

As a NGINX Gateway Fabric contributor,
I want the latest version of the product to be controlled by a variable,
So I can easily update multiple documents.

Description

NGINX Ingress Controller has a neat pattern where they repurpose Hugo's shortcodes as variables in order to easily manage updating references to the latest version of software. I find it a clever workaround for a lack of content variables in Hugo, and would like to adopt it for NGINX Gateway Fabric (and other documentation sets in the future).

Acceptance criteria

  • Create a ngf-version shortcode
  • Replace all instances of the "latest" documentation tag with this version shortcode

Beware of an editor automatically adding a blank line. The shortcode file should just have a string for the version, no extra line break characters. I've seen this break the formatting and behaviour in NGINX Ingress Controller.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationproduct/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