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

Write a guide on how to use ClientSettingsPolicy #1763

Closed
kate-osborn opened this issue Mar 22, 2024 · 0 comments · Fixed by #2071
Closed

Write a guide on how to use ClientSettingsPolicy #1763

kate-osborn opened this issue Mar 22, 2024 · 0 comments · Fixed by #2071
Assignees
Labels
documentation Improvements or additions to documentation refined Requirements are refined and the issue is ready to be implemented. size/medium Estimated to be completed within a week
Milestone

Comments

@kate-osborn
Copy link
Contributor

kate-osborn commented Mar 22, 2024

As a user of NGF
I want a guide on NGF's ClientSettingsPolicy to implement the use cases this policy enables
So that I can make us of the policy in my own NGF deployment.

Acceptance

  • A general NGF policy reference doc is created to detail all of the fields of the ClientSettingsPolicy and statuses of any of our custom policies.
  • A guide is created to explain what NGF's ClientSettingsPolicy is and how to achieve the use cases the policy enables.
    • The values used in the guide are the most common values / use cases to make copy / paste easier.
    • The guide includes examples of success and failure statuses for the policy.
    • A use case is included to cover how to fix 413s
  • Ensure our troubleshooting guide includes how to fix 413s
@kate-osborn kate-osborn added this to the v1.3.0 milestone Mar 29, 2024
@mpstefan mpstefan changed the title Write a tutorial on how to use ClientSettingsPolicy Write a guide on how to use ClientSettingsPolicy May 20, 2024
@mpstefan mpstefan added documentation Improvements or additions to documentation refined Requirements are refined and the issue is ready to be implemented. size/medium Estimated to be completed within a week labels May 20, 2024
@kate-osborn kate-osborn self-assigned this May 22, 2024
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 refined Requirements are refined and the issue is ready to be implemented. size/medium Estimated to be completed within a week
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants