Skip to content

Conversation

@sharadregoti
Copy link
Contributor

@sharadregoti sharadregoti commented Nov 14, 2025

PR Type

Documentation


Description

  • Update docs configuration in docs.json

  • Revert or adjust redirect-related settings


Diagram Walkthrough

flowchart LR
  A["docs.json (redirects/config)"] -- "revert/adjust settings" --> B["Docs site behavior"]
Loading

File Walkthrough

Relevant files
Documentation
docs.json
Adjust docs redirects configuration                                           

docs.json

  • Modify documentation configuration
  • Revert or tweak redirect rules
+3949/-1

@github-actions
Copy link

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ No major issues detected

@github-actions
Copy link

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
Possible issue
Fix misspelled redirect path

The source path contains a typo in "graceful-shutdowm" which will prevent the
redirect from matching. Correct the misspelling to "graceful-shutdown" to ensure the
route redirects properly.

docs.json [2336-2338]

 {
-  "source": "/tyk-stack/tyk-pump/tyk-pump-configuration/graceful-shutdowm",
+  "source": "/tyk-stack/tyk-pump/tyk-pump-configuration/graceful-shutdown",
   "destination": "/planning-for-production/ensure-high-availability/graceful-shutdown"
 }
Suggestion importance[1-10]: 8

__

Why: The source path has a clear typo (graceful-shutdowm) that will break the redirect; correcting it to graceful-shutdown is accurate and improves functionality.

Medium
Remove invalid URL fragment

The source includes a trailing "rel=" fragment which is not a valid route and likely
from a broken link. Remove the fragment to the intended base path so the redirect
can match.

docs.json [3116-3118]

 {
-  "source": "/concepts/tyk-components/identity-broker/rel=",
+  "source": "/concepts/tyk-components/identity-broker",
   "destination": "/api-management/external-service-integration"
 }
Suggestion importance[1-10]: 7

__

Why: The source contains an invalid trailing rel= fragment; removing it to point to /identity-broker is reasonable and likely intended, though the exact target could depend on site structure.

Medium
Correct truncated route segment

The source path is truncated ("identity-broke") and will never match the expected
page. Correct it to "identity-broker" to ensure the redirect functions.

docs.json [3120-3122]

 {
-  "source": "/getting-started/tyk-components/identity-broke",
+  "source": "/getting-started/tyk-components/identity-broker",
   "destination": "/api-management/external-service-integration"
 }
Suggestion importance[1-10]: 7

__

Why: The source identity-broke appears truncated; changing it to identity-broker is a sensible fix that will make the redirect match, with low risk and clear intent.

Medium

@sharadregoti sharadregoti merged commit fb2c100 into main Nov 14, 2025
7 checks passed
@buger
Copy link
Member

buger commented Nov 14, 2025

/release to release-5.10

buger pushed a commit that referenced this pull request Nov 14, 2025
(cherry picked from commit fb2c100)
@github-actions
Copy link

✅ Cherry-pick successful. A PR was created and auto-merged (if allowed): #953

buger added a commit that referenced this pull request Nov 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants