Merging to release-5.4: [DX-1680] Fix urls (#5388)

buger commented 1 month ago

User description

DX-1680 Fix urls (#5388)

Fix links in:

Update redis-pubsub.md
Update endpoint-cache-tyk-classic.md

PR Type

Documentation

Description

Fixed typos and improved clarity in the endpoint-cache-tyk-classic.md documentation.
Corrected a link to the request body caching documentation in endpoint-cache-tyk-classic.md.
Updated the link to interpolation functions documentation in redis-pubsub.md.

Changes walkthrough 📝

Relevant files

Documentation

endpoint-cache-tyk-classic.md `Fix typos and correct link in endpoint cache documentation` tyk-docs/content/product-stack/tyk-gateway/middleware/endpoint-cache-tyk-classic.md Fixed a typo in the description of caching requests. Corrected a link to the request body caching documentation. Minor grammatical correction for clarity.	+3/-3
redis-pubsub.md `Fix link to interpolation functions documentation` tyk-docs/content/product-stack/tyk-streaming/configuration/outputs/redis-pubsub.md - Corrected the link to the interpolation functions documentation.	+1/-1

💡 PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

netlify[bot] commented 1 month ago

PS. Pls add /docs/nightly to the end of url

Name	Link
Latest commit	ee48a1be5238ce3271cdd727e6b6145e62bad853
Latest deploy log	https://app.netlify.com/sites/tyk-docs/deploys/66e057813da2990008ba4409
Deploy Preview	https://deploy-preview-5390--tyk-docs.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

github-actions[bot] commented 1 month ago

PR Reviewer Guide 🔍

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Key issues to review

Typo Fix
The PR corrects a typo in the link for request body caching documentation. The original link had an extra space which could potentially lead to a broken link. Clarity Improvement
Added clarity in the description of the caching mechanism for specific endpoints. Link Correction
Corrected the link to interpolation functions documentation, fixing a malformed URL that included '.mdinterpolation' which could lead to a broken link.

github-actions[bot] commented 1 month ago

PR Code Suggestions ✨

Category	Suggestion	Score
Possible issue	Correct the hyperlink by fixing the typographical error in the URL ___ Correct the hyperlink to point to the intended markdown file by ensuring the URL is accurate and does not contain typographical errors. The original link has '.mdinterpolation' which seems to be a typo. [tyk-docs/content/product-stack/tyk-streaming/configuration/outputs/redis-pubsub.md [247]](https://github.com/TykTechnologies/tyk-docs/pull/5390/files#diff-8e83381560810874536889d0659c04e044a0f4ebfe464057b354e5350659c1d1R247-R247) ```diff -This field supports [interpolation functions]({{< ref "/product-stack/tyk-streaming/configuration/common-configuration/interpolation.mdinterpolation#bloblang-queries" >}}). +This field supports [interpolation functions]({{< ref "/product-stack/tyk-streaming/configuration/common-configuration/interpolation#bloblang-queries" >}}). ``` Suggestion importance[1-10]: 10 Why: The suggestion addresses a critical typographical error in the hyperlink, ensuring the link directs to the correct location, which is essential for documentation accuracy.	10
Possible issue	Correct the hyperlink reference by removing the unnecessary space ___ Ensure that the hyperlink reference in the markdown file is correctly formatted without spaces. The original link contains an unnecessary space which might cause the link to break or not function as intended. [tyk-docs/content/product-stack/tyk-gateway/middleware/endpoint-cache-tyk-classic.md [60]](https://github.com/TykTechnologies/tyk-docs/pull/5390/files#diff-993670e17f43b2179867579221d68d9ce473260bfb1f477ee5301b5f5a1dd81fR60-R60) ```diff -- a pattern match to cache only requests containing specific data in the [request body]({{< ref " basic-config-and-security/reduce-latency/caching/advanced-cache#selective-caching-by-body-value" >}}) +- a pattern match to cache only requests containing specific data in the [request body]({{< ref "basic-config-and-security/reduce-latency/caching/advanced-cache#selective-caching-by-body-value" >}}) ``` Suggestion importance[1-10]: 9 Why: The suggestion correctly identifies and fixes a formatting issue in the hyperlink reference, which is crucial for ensuring the link functions as intended.	9

netlify[bot] commented 1 month ago

PS. Pls add /docs/nightly to the end of url

Name	Link
Latest commit	1a541ac02f618a8a87cf6c7d0faa6543785e3eaf
Latest deploy log	https://app.netlify.com/sites/tyk-docs/deploys/66e057f6b954930008b3d9c9
Deploy Preview	https://deploy-preview-5390--tyk-docs.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

TykTechnologies / tyk-docs