Skip to content

Commit 9b62bc5

Browse files
authored
Add Helm Chart configuration table reference to installation guide (#1452)
* Add Helm Chart configuration table reference to installation guide This commit adds a prominent section to the documentation's Helm installation guide to direct a reader to the Helm README which has all of its configurable parameters. This information is being referenced instead of duplicated to avoid drift, which has the side-effect of making the Helm chart itself a single source of truth. * Update Helm README link to main branch, amend release process document
1 parent 9c1d3e9 commit 9b62bc5

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

docs/developer/release-process.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ To create a new release, follow these steps:
4444
file.
4545
5. Generate the installation manifests by running `make generate-manifests`.
4646
6. Modify any `git clone` instructions to use `vX.Y.Z` tag.
47-
7. Modify any docs links that refer to `main` to instead refer to `vX.Y.Z`.
47+
7. Modify any docs links that refer to `main` to instead refer to `vX.Y.Z` or `release-x-y`, whichever is applicable.
4848
8. Update any installation instructions to ensure that the supported Gateway API and NGF versions are correct.
4949
Specifically, helm README and `site/content/includes/installation/install-gateway-api-resources.md`.
5050
9. Update the [README](/README.md) to include information about the release.

site/content/installation/installing-ngf/helm.md

+4
Original file line numberDiff line numberDiff line change
@@ -215,6 +215,10 @@ Follow these steps to uninstall NGINX Gateway Fabric and Gateway API from your K
215215

216216
- {{<include "installation/uninstall-gateway-api-resources.md" >}}
217217

218+
## Additional configuration
219+
220+
For a full list of the Helm Chart configuration parameters, read [the NGINX Gateway Fabric Helm Chart](https://github.com/nginxinc/nginx-gateway-fabric/blob/main/deploy/helm-chart/README.md#configuration).
221+
218222
## Next steps
219223

220224
### Expose NGINX Gateway Fabric

0 commit comments

Comments
 (0)