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 howto doc for path-regex annotations #4266

Merged
merged 8 commits into from
Aug 18, 2023
Merged

Add howto doc for path-regex annotations #4266

merged 8 commits into from
Aug 18, 2023

Conversation

jjngx
Copy link
Contributor

@jjngx jjngx commented Aug 18, 2023

Proposed changes

This PR adds a document guiding users how to apply nginx.org/path-regex annotations to simple and mergeable ingresses.

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

@jjngx jjngx added the documentation Pull requests/issues for documentation label Aug 18, 2023
@jjngx jjngx added this to the v3.3.0 milestone Aug 18, 2023
@jjngx jjngx requested review from a team as code owners August 18, 2023 10:21
@codecov
Copy link

codecov bot commented Aug 18, 2023

Codecov Report

Merging #4266 (ea826db) into main (25b9e05) will decrease coverage by 0.03%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #4266      +/-   ##
==========================================
- Coverage   51.97%   51.95%   -0.03%     
==========================================
  Files          59       59              
  Lines       16762    16762              
==========================================
- Hits         8712     8708       -4     
- Misses       7753     7755       +2     
- Partials      297      299       +2     

see 1 file with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

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.

Approved, but I made a lot of suggestions about nouns, prepositions and articles.

There's also a lot of missing punctuation for the end of instruction steps.

docs/content/tutorials/ingress-path-regex-annotation.md Outdated Show resolved Hide resolved
docs/content/tutorials/ingress-path-regex-annotation.md Outdated Show resolved Hide resolved
docs/content/tutorials/ingress-path-regex-annotation.md Outdated Show resolved Hide resolved
docs/content/tutorials/ingress-path-regex-annotation.md Outdated Show resolved Hide resolved
docs/content/tutorials/ingress-path-regex-annotation.md Outdated Show resolved Hide resolved
docs/content/tutorials/ingress-path-regex-annotation.md Outdated Show resolved Hide resolved
docs/content/tutorials/ingress-path-regex-annotation.md Outdated Show resolved Hide resolved
docs/content/tutorials/ingress-path-regex-annotation.md Outdated Show resolved Hide resolved
docs/content/tutorials/ingress-path-regex-annotation.md Outdated Show resolved Hide resolved
docs/content/tutorials/ingress-path-regex-annotation.md Outdated Show resolved Hide resolved
@jjngx jjngx merged commit 0c643ca into main Aug 18, 2023
@jjngx jjngx deleted the docs/path-regex-howto branch August 18, 2023 17:27
Copy link
Collaborator

@brianehlert brianehlert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Pull requests/issues for documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants