add a couple notes about redirect particularities.#2635
Open
ElliotFriend wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds guidance for writing and reviewing NGINX redirects.
Changes:
- Adds inline redirect syntax warnings.
- Expands contributor guidance for regex-based redirects.
Recommendation: NEEDS-CHANGES — align the conflicting curly-brace guidance and clarify the NGINX parser constraint.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
nginx/includes/redirects.conf |
Adds redirect-authoring cautions. |
CONTRIBUTING.md |
Documents regex quoting and review requirements. |
Comment on lines
+1
to
+2
| ## nginx redirects file. write carefully, syntax must be precise. don't use | ||
| ## curly braces "{}" in these. it's a headache. |
|
|
||
| To the extent possible, anything that changes a page's URL needs redirect coverage (`routes.txt` participates in CI route checking; server-side redirects live in `nginx/`). If your PR moves or renames pages, call it out explicitly in the description. | ||
|
|
||
| Redirects written for nginx can be tricky. The syntax MUST be precise, and regular expressions don't always behave like they do elsewhere (e.g., regexes with curly braces `{}` must be fully contained by quotes `"`). If a URL rewrite is introduced using a regular expression, a close test and review from maintainers is required. |
|
Preview is available here: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.