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 SnippetsFilter guide #2721

Merged
merged 20 commits into from
Nov 12, 2024
Merged

Add SnippetsFilter guide #2721

merged 20 commits into from
Nov 12, 2024

Conversation

bjee19
Copy link
Contributor

@bjee19 bjee19 commented Oct 23, 2024

Add SnippetsFilters guide.

Problem: We want a guide for using SnippetsFilters.

Solution: Add a SnippetsFilters guide.

Testing: Verified using make watch Hugo command.

Closes #2377

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.


@bjee19 bjee19 requested review from a team as code owners October 23, 2024 21:17
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 23, 2024
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 generally: I'd consider using the ghcode shortcode to explicitly show the YAML contents of files, but it might lead to reading fatigue.

Using it for the code that includes the actual snippets could show the reader what to expect if they decide to configure NGF with them, at least.

site/content/how-to/traffic-management/snippets-filters.md Outdated Show resolved Hide resolved
examples/snippets-filter/README.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/snippets-filters.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/snippets-filters.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/snippets-filters.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/snippets-filters.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/snippets-filters.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/snippets-filters.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/snippets-filters.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/snippets-filters.md Outdated Show resolved Hide resolved
Copy link

codecov bot commented Oct 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.40%. Comparing base (a48a1ea) to head (ffd09a4).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2721   +/-   ##
=======================================
  Coverage   89.40%   89.40%           
=======================================
  Files         110      110           
  Lines       10913    10913           
  Branches       50       50           
=======================================
  Hits         9757     9757           
  Misses       1098     1098           
  Partials       58       58           

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

examples/snippets-filter/README.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/snippets.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/snippets.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/snippets.md Outdated Show resolved Hide resolved
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. Small changes, having taken a fresher look at the document in its totality.

site/content/how-to/traffic-management/snippets.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/snippets.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/snippets.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/snippets.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/snippets.md Outdated 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.

Great work on this @bjee19. Sorry to jump in late with comments.

site/content/how-to/traffic-management/snippets.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/snippets.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/snippets.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/snippets.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/snippets.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/snippets.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/snippets.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/snippets.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/snippets.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/snippets.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/snippets.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/snippets.md Outdated 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.

Left one suggestion that I'll leave up to you. Great work!

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!

@bjee19 bjee19 merged commit 30ebe68 into nginxinc:main Nov 12, 2024
42 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 for Configuring Snippets in NGF
5 participants