Skip to content

Conversation

@shaun-nx
Copy link
Contributor

Proposed changes

This change adds a new page to the NGF Install section on how to install the NGF on OpenShift using the RedHat Operator Hub.

This guide also includes Operator specific configurations as well as troubleshooting.

Closes nginx/nginx-gateway-fabric#3911

Checklist

Before sharing this pull request, I completed the following checklist:

Footnotes

  1. Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the style guide for guidance about placeholder content.

sarthyparty and others added 11 commits September 3, 2025 10:16
Update compatability doc with Port for ParentRef
Update gateway addresses compatibility document.
…omment (#1126)

Add a small comment on IP families to gateway addresses compatibility document.
Added mention about unsupported fields for RouteRules and Gateways
Closes nginx/nginx-gateway-fabric#3784
feat: Update advanced routing guide for regex path
…cs (#1284)

* Add details on BuildOS and InferencePoolCount to Product Telemetry docs
* Add InferencePoolCount
* Move InferencePool resource into "Count of Resources" section
@shaun-nx shaun-nx requested a review from a team as a code owner October 20, 2025 09:20
@github-actions github-actions bot added documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric labels Oct 20, 2025
@github-actions
Copy link

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/docs/1332/

@shaun-nx shaun-nx requested a review from a team October 20, 2025 15:03
@shaun-nx shaun-nx changed the base branch from ngf-release-2.2 to main October 21, 2025 16:12
@shaun-nx
Copy link
Contributor Author

Changing the base branch to main as we need to wait until we have fully published the Operator to Openshift before making this doc available

Copy link
Contributor

@salonichf5 salonichf5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mentioned a couple of nits but overall looks good. I think this branch needs a rebase with main

great job 🥳

@tataruty
Copy link
Contributor

Changing the base branch to main as we need to wait until we have fully published the Operator to Openshift before making this doc available

Did you change base branch too? or only the aim of merge? I see many commits difference

Copy link
Member

@ADubhlaoich ADubhlaoich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Broadly speaking, the new page needs to be restructured.

It doesn't adhere to our contemporary page standards:

  • It's missing the documentation metadata
  • The requirements section is not named correctly
  • It uses the NGF three letter acronym: we do not use TLAs in public-facing documentation
  • It uses bash as a formatting language, when shell has been the norm for months
  • It doesn't use Hugo for list enumeration

Many of the structural issues could have been avoided by using Hugo archetypes, for which we maintain documentation which is part of the Contributing guidelines as the first item in the PR checklist.

Effectively no commits on this branch adhere to the Git conventions as the second item in the PR checklist, though this does not need to be fixed in retrospect as long as the eventual merge message is correct.

@shaun-nx shaun-nx requested a review from ciarams87 October 29, 2025 11:23
@JTorreG
Copy link
Contributor

JTorreG commented Oct 29, 2025

I have addressed everything except this in Slack.
leaving this one for @ADubhlaoich

The requirements section is not named correctly

This document doesn't have a requirements section at all, so it's not clear what you mean by this. Should we have a requirements section?

@shaun-nx shaun-nx requested a review from bjee19 November 3, 2025 16:22
@shaun-nx shaun-nx requested a review from bjee19 November 5, 2025 09:56
Copy link
Member

@ADubhlaoich ADubhlaoich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Copy link
Contributor

@JTorreG JTorreG left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved in principle, assuming the erroneous nd-docs value is removed

@shaun-nx shaun-nx enabled auto-merge (squash) November 5, 2025 13:41
@shaun-nx shaun-nx merged commit aa50450 into main Nov 5, 2025
9 checks passed
@shaun-nx shaun-nx deleted the ngf/openshift-install branch November 5, 2025 13:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create OpenShift installation documentation

10 participants