-
Notifications
You must be signed in to change notification settings - Fork 121
Add document for installing NGF on OpenShift through OperatorHub #1332
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
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
✅ Deploy Preview will be available once build job completes!
|
|
Changing the base branch to |
There was a problem hiding this 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 🥳
Did you change base branch too? or only the aim of merge? I see many commits difference |
There was a problem hiding this 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
bashas a formatting language, whenshellhas 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.
|
I have addressed everything except this in Slack.
|
Co-authored-by: bjee19 <139261241+bjee19@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
There was a problem hiding this 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
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
Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the style guide for guidance about placeholder content. ↩