nginxinc / nginx-gateway-fabric

NGINX Gateway Fabric provides an implementation for the Gateway API using NGINX as the data plane.
Apache License 2.0
501 stars 97 forks source link

Add description for enabling experimental features #2546

Closed bjee19 closed 1 month ago

bjee19 commented 2 months ago

Proposed changes

Add includes description for enabling experimental features and the risks that are associated with using experimental features.

Problem: There is insufficient documentation on enabling experimental features in our guides.

Solution: Add an includes description for enabling experimental features that we can use for any guides on experimental features. Also updated gateway api compatibility document.

Testing: Locally generated the documentation through Hugo and it works.

Closes #2481

Checklist

Before creating a PR, run through this checklist and mark each as complete.

Release notes

If this PR introduces a change that affects users and needs to be mentioned in the release notes, please add a brief note that summarizes the change.

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 89.29%. Comparing base (d242622) to head (b58bc2c). Report is 1 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #2546 +/- ## ======================================= Coverage 89.29% 89.29% ======================================= Files 100 100 Lines 7633 7633 Branches 50 50 ======================================= Hits 6816 6816 Misses 761 761 Partials 56 56 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.