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

Move Advanced NGINX Extensions proposal to Implementable #2201

Merged
merged 28 commits into from
Jul 18, 2024

Conversation

pleshakov
Copy link
Contributor

Proposed changes

Problem:

Solution:

  • Add the implementation details to the proposal.
  • Move the enhancement proposal to Implementable

Notes:

  • The goal of Allowing users to customize supported NGINX configuration was moved to a Non-Goal to keep the size of the proposal manageable.
  • This enhancement proposal can be further split into two - one for SnippetsPolicy and one for SnippetsTemplates

CLOSES - #815

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.

NONE

Problem:
- Advanced NGINX Extensions proposal nginxinc#2035
  is in Provisional state - only problem statement is defined.

Solution:
- Add the implementation details to the proposal.
- Move the enhancement proposal to Implementable

Notes:
- The goal of Allowing users to customize supported NGINX configuration
  was moved to a Non-Goal to keep the size of the proposal manageable.
- This enhancement proposal can be further split into two - one for
  SnippetsPolicy and one for SnippetsTemplates

CLOSES - nginxinc#815
@github-actions github-actions bot added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 3, 2024
@kate-osborn
Copy link
Contributor

@pleshakov is this PR ready for review?

@pleshakov pleshakov marked this pull request as ready for review July 8, 2024 17:01
@pleshakov pleshakov requested review from a team as code owners July 8, 2024 17:01
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.

Fantastic work on this @pleshakov!

docs/proposals/advanced-nginx-extensions.md Outdated Show resolved Hide resolved
docs/proposals/advanced-nginx-extensions.md Show resolved Hide resolved
docs/proposals/advanced-nginx-extensions.md Outdated Show resolved Hide resolved
docs/proposals/advanced-nginx-extensions.md Outdated Show resolved Hide resolved
docs/proposals/advanced-nginx-extensions.md Outdated Show resolved Hide resolved
docs/proposals/advanced-nginx-extensions.md Show resolved Hide resolved
docs/proposals/advanced-nginx-extensions.md Show resolved Hide resolved
docs/proposals/advanced-nginx-extensions.md Outdated Show resolved Hide resolved
docs/proposals/advanced-nginx-extensions.md Outdated Show resolved Hide resolved
docs/proposals/advanced-nginx-extensions.md Show resolved Hide resolved
@pleshakov pleshakov requested a review from mpstefan July 9, 2024 17:37
@pleshakov pleshakov requested a review from sjberman July 12, 2024 18:25
Copy link

codecov bot commented Jul 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.76%. Comparing base (4813408) to head (37ebccb).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2201   +/-   ##
=======================================
  Coverage   87.76%   87.76%           
=======================================
  Files          96       96           
  Lines        6793     6793           
  Branches       50       50           
=======================================
  Hits         5962     5962           
  Misses        774      774           
  Partials       57       57           

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

Copy link
Contributor

@sjberman sjberman left a comment

Choose a reason for hiding this comment

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

Should we update the doc to "Implementable"?

docs/proposals/advanced-nginx-extensions.md Show resolved Hide resolved
docs/proposals/advanced-nginx-extensions.md Show resolved Hide resolved
Copy link
Collaborator

@mpstefan mpstefan left a comment

Choose a reason for hiding this comment

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

Had comments that were addressed later in the doc... well done! Really looking forward to getting this in the product.

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.

Just a few small comments, but otherwise LGTM 🚀

docs/proposals/advanced-nginx-extensions.md Outdated Show resolved Hide resolved
docs/proposals/advanced-nginx-extensions.md Outdated Show resolved Hide resolved
docs/proposals/advanced-nginx-extensions.md Outdated Show resolved Hide resolved
docs/proposals/advanced-nginx-extensions.md Outdated Show resolved Hide resolved
docs/proposals/advanced-nginx-extensions.md Outdated Show resolved Hide resolved
docs/proposals/advanced-nginx-extensions.md Show resolved Hide resolved
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.

🚀

@sjberman
Copy link
Contributor

My only other comment would be to change the status to Implementable.

@pleshakov pleshakov requested a review from sjberman July 16, 2024 05:51
@pleshakov pleshakov merged commit e8e494f into nginxinc:main Jul 18, 2024
37 checks passed
@pleshakov pleshakov deleted the enh/advanced-nginx-extensions-impl branch July 18, 2024 15:14
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 enhancement New feature or request
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants