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 how-to for ClientSettingsPolicy #2071

Merged
merged 6 commits into from
Jun 7, 2024

Conversation

kate-osborn
Copy link
Contributor

Proposed changes

Problem: No user guide on how to use ClientSettingsPolicy.

Solution: Add a how-to guide that explains how to use ClientSettingsPolicy to configure client max body size.

Testing: Ran through steps and made sure they worked

Please focus on: Is it enough to show how to configure client max body size? Should we show off other client settings? Client max body size is the best demo end-to-end. We could set keepalive requests to 0 and show that the connection is not reused in the curl logs, but that isn't as impactful.

Closes #1763

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

@github-actions github-actions bot added the documentation Improvements or additions to documentation label May 31, 2024
@pleshakov
Copy link
Contributor

looks good to me

Please focus on: Is it enough to show how to configure client max body size? Should we show off other client settings? Client max body size is the best demo end-to-end. We could set keepalive requests to 0 and show that the connection is not reused in the curl logs, but that isn't as impactful.

just max body size is 👍

@kate-osborn
Copy link
Contributor Author

I'm still working on the doc on policy merging and inheritance behavior (#1995), but this can be reviewed and merged separately, so marking as ready.

@kate-osborn kate-osborn marked this pull request as ready for review May 31, 2024 21:10
@kate-osborn kate-osborn requested review from a team as code owners May 31, 2024 21:10
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, made a bunch of suggestions to add a declarative, imperative tone.

We avoid passive voice where possible and don't want to be too familiar, which is why I got rid of all of the "We" and "Let's" I spotted.

site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/troubleshooting.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/client-settings.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/client-settings.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/client-settings.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/client-settings.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/client-settings.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/client-settings.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/client-settings.md Outdated Show resolved Hide resolved
@kate-osborn kate-osborn force-pushed the docs/client-settings branch from eee56ff to d0604cc Compare June 4, 2024 17:52
@kate-osborn
Copy link
Contributor Author

kate-osborn commented Jun 4, 2024

@ADubhlaoich I re-requested your review because I added a couple callouts about a known limitation: d341771

@kate-osborn kate-osborn force-pushed the docs/client-settings branch from df3b1cb to d341771 Compare June 4, 2024 18:25
@kate-osborn kate-osborn requested a review from sjberman June 4, 2024 18:25
@bjee19
Copy link
Contributor

bjee19 commented Jun 4, 2024

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 still, small suggestion for phrasing the tracing note.

site/content/how-to/monitoring/tracing.md Outdated Show resolved Hide resolved
@kate-osborn kate-osborn force-pushed the docs/client-settings branch from a32cf4b to 0e6a6e2 Compare June 6, 2024 21:41
@kate-osborn kate-osborn force-pushed the docs/client-settings branch from 0e6a6e2 to 6932923 Compare June 7, 2024 19:21
@kate-osborn kate-osborn merged commit 127c0ed into nginx:main Jun 7, 2024
41 checks passed
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
None yet
Development

Successfully merging this pull request may close these issues.

Write a guide on how to use ClientSettingsPolicy
6 participants