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 overview of custom NGF policies #2088

Merged
merged 8 commits into from
Jun 10, 2024
Merged

Conversation

kate-osborn
Copy link
Contributor

Proposed changes

Add an overview of NGF policies.

Problem: There's no documentation that describes how NGF policies work.

Solution: Add a document that gives an overview of NGF custom policies. This overview includes a summary of the policies, how they are applied, how they are merged, and the format of their statuses.

Closes #1995

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.


@kate-osborn kate-osborn requested review from a team as code owners June 4, 2024 20:54
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jun 4, 2024
@kate-osborn kate-osborn requested a review from sjberman June 4, 2024 22:00
@kate-osborn
Copy link
Contributor Author

@ADubhlaoich can you help me with the table of contents for this doc? It's only showing the Overview header:

Screenshot 2024-06-04 at 4 01 44 PM

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.

My apologies for the requested changes, but the image alt text must be addressed.

https://www.w3.org/WAI/tutorials/images/decision-tree/
https://www.w3.org/WAI/tutorials/images/complex/

Beyond that (And some minor suggestions), LGTM.

site/content/overview/custom-policies.md Outdated Show resolved Hide resolved
site/content/overview/custom-policies.md Outdated Show resolved Hide resolved
site/content/overview/custom-policies.md Show resolved Hide resolved
site/content/overview/custom-policies.md Outdated Show resolved Hide resolved
site/content/overview/custom-policies.md Outdated Show resolved Hide resolved
site/content/overview/custom-policies.md Outdated Show resolved Hide resolved
site/content/overview/custom-policies.md Outdated Show resolved Hide resolved
site/content/overview/custom-policies.md Outdated Show resolved Hide resolved
site/content/overview/custom-policies.md Outdated Show resolved Hide resolved
site/content/overview/custom-policies.md Outdated Show resolved Hide resolved
@ADubhlaoich
Copy link
Contributor

@ADubhlaoich can you help me with the table of contents for this doc? It's only showing the Overview header:

Screenshot 2024-06-04 at 4 01 44 PM

I think this might possibly be caused by the broken table, so we'll see how it stands after the fix.

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!

@kate-osborn kate-osborn merged commit b3e7d39 into nginxinc:main Jun 10, 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
Status: Done
Development

Successfully merging this pull request may close these issues.

Guide on How NGF Custom Policies Merge
5 participants