Skip to content
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

Add description for enabling experimental features #2546

Merged
merged 11 commits into from
Sep 19, 2024

Conversation

bjee19
Copy link
Contributor

@bjee19 bjee19 commented Sep 12, 2024

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.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

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.


@bjee19 bjee19 requested review from a team as code owners September 12, 2024 21:04
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Sep 12, 2024
Copy link

codecov bot commented Sep 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

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

Additional details and impacted files
@@           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           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@kate-osborn kate-osborn 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

@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! Added a number of suggestions and confirmed input from other reviewers, but nothing critically requires editing.

Copy link
Contributor

@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.

Re-approved, responded to the threads. Good to resolve them all, didn't want to do it myself in case the context was missed.

@bjee19 bjee19 force-pushed the docs/experimental-features-guide branch from 2279ee4 to 721c2bd Compare September 19, 2024 15:37
@bjee19 bjee19 force-pushed the docs/experimental-features-guide branch from 721c2bd to b58bc2c Compare September 19, 2024 16:07
@bjee19 bjee19 merged commit 35f2b91 into nginxinc:main Sep 19, 2024
40 checks passed
@bjee19 bjee19 mentioned this pull request Oct 31, 2024
6 tasks
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
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

TLS Passthrough how-to guide missing instructions on enabling experimental features
5 participants