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 request header tutorial to how-to guides #2715

Merged
merged 33 commits into from
Oct 28, 2024

Conversation

salonichf5
Copy link
Contributor

Proposed changes

Write a clear and concise description that helps reviewers understand the purpose and impact of your changes. Use the
following format:

Problem: Users need a consolidated document for both request and response header modifiers

Solution: Updated existing response header modifier guide with request header modifier docs.

Testing: Testing using make watch

Please focus on (optional): If you any specific areas where you would like reviewers to focus their attention or provide
specific feedback, add them here.

Closes #2270

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.


@salonichf5 salonichf5 requested review from a team as code owners October 22, 2024 15:29
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 22, 2024
@salonichf5 salonichf5 changed the title update doc to add request header to how to guides Add request header tutorial to how-to guides Oct 22, 2024
Copy link
Contributor

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/nginx-gateway-fabric/2715/

@salonichf5 salonichf5 marked this pull request as draft October 22, 2024 16:02
@salonichf5 salonichf5 force-pushed the docs/request-header-modifier branch from 105d451 to 3f40db7 Compare October 22, 2024 16:27
@salonichf5 salonichf5 marked this pull request as ready for review October 22, 2024 16:27
Copy link

codecov bot commented Oct 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.38%. Comparing base (71a6c5c) to head (05ed810).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2715   +/-   ##
=======================================
  Coverage   89.38%   89.38%           
=======================================
  Files         110      110           
  Lines       10913    10913           
  Branches       50       50           
=======================================
  Hits         9755     9755           
  Misses       1100     1100           
  Partials       58       58           

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

@salonichf5 salonichf5 requested a review from sjberman October 23, 2024 00:52
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.

Made a lot of edit suggestions. Requesting changes so that the remaining sections are changed to fit the style of everything else (Remove informal language, add line breaks before headings, etc).

Since there are repeat steps for setting the headers application up, you can make setting it up its own section and refer back to it the second time- removes the redundancy, cuts down on the amount of text.

examples/http-request-header-filter/README.md Outdated Show resolved Hide resolved
examples/http-request-header-filter/README.md Outdated Show resolved Hide resolved
examples/http-response-header-filter/README.md Outdated Show resolved Hide resolved
@salonichf5 salonichf5 force-pushed the docs/request-header-modifier branch from ad60c3e to 37d3a0f Compare October 23, 2024 18:15
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.

Some more small things! LGTM.

salonichf5 and others added 21 commits October 28, 2024 13:50
@salonichf5 salonichf5 force-pushed the docs/request-header-modifier branch from bc7742d to 05ed810 Compare October 28, 2024 20:50
@salonichf5 salonichf5 enabled auto-merge (squash) October 28, 2024 20:50
@salonichf5 salonichf5 merged commit 1403b2c into main Oct 28, 2024
43 checks passed
@salonichf5 salonichf5 deleted the docs/request-header-modifier branch October 28, 2024 21:02
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.

User Guide: Add doc for Request Header modification
3 participants