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

Merging to release-5.7: Fix Duplicate Title/Content Issues (#5905) #5912

Merged

Conversation

buger
Copy link
Member

@buger buger commented Jan 21, 2025

User description

Fix Duplicate Title/Content Issues (#5905)

Fixed Issue raised by marketing team


PR Type

Documentation


Description

  • Removed outdated Gateway API documentation and updated references.

  • Renamed and clarified titles for Tyk Streams input/output pages.

  • Updated menu structure to remove Gateway API entry.

  • Added alias for the removed Gateway API documentation.


Changes walkthrough 📝

Relevant files
Documentation
12 files
deploy-apis-overview.md
Updated reference to `Gateway API` documentation                 
+1/-1     
gateway-api.md
Removed outdated `Gateway API` documentation file               
+0/-13   
high-level-concepts.md
Updated title for Tyk OAS introduction page                           
+1/-1     
broker.md
Updated title for Tyk Streams Broker Input page                   
+1/-1     
http-server.md
Updated title for Tyk Streams Http Server Input page         
+1/-1     
kafka.md
Updated title for Tyk Streams Kafka Input page                     
+1/-1     
broker.md
Updated title for Tyk Streams Broker Output page                 
+1/-1     
http-server.md
Updated title for Tyk Streams Http Server Output page       
+1/-1     
kafka.md
Updated title for Tyk Streams Kafka Output page                   
+1/-1     
dynamic-client-registration.md
Renamed title for Classic Portal Dynamic Client Registration page
+1/-1     
tyk-gateway-api.md
Added alias for removed `Gateway API` documentation           
+2/-1     
menu.yaml
Removed `Gateway API` entry from menu structure                   
+0/-4     

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

Fixed Issue raised by marketing team

(cherry picked from commit 5b47bad)
@buger buger enabled auto-merge (squash) January 21, 2025 11:54
Copy link
Contributor

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis ✅

5905 - Fully compliant

Fully compliant requirements:

  • Remove outdated Gateway API documentation file.
  • Update titles for Tyk Streams input/output configuration files.
  • Rename and clarify titles for multiple documentation pages.
  • Update menu structure to remove Gateway API entry.
  • Add alias for removed Gateway API documentation.

Not compliant requirements:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Possible Broken Link

The updated reference to Gateway API (tyk-gateway-api) should be validated to ensure it correctly points to the intended content.

- [Gateway API]({{<ref "tyk-gateway-api">}})
Typographical Error

The title Tyk Strems Broker Input contains a typo in the word "Strems" which should be corrected to "Streams".

title: Tyk Strems Broker Input

Copy link
Contributor

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Score
General
Fix typo in the title

Correct the typo in the title "Tyk Strems Broker Input" to "Tyk Streams Broker
Input" to ensure consistency and clarity.

tyk-docs/content/product-stack/tyk-streaming/configuration/inputs/broker.md [2]

-title: Tyk Strems Broker Input
+title: Tyk Streams Broker Input
Suggestion importance[1-10]: 9

Why: The suggestion addresses a clear typo in the title, improving clarity and consistency. This is a straightforward and impactful correction.

9
Correct acronym capitalization in title

Capitalize "Http" to "HTTP" in the title for proper acronym usage and consistency.

tyk-docs/content/product-stack/tyk-streaming/configuration/inputs/http-server.md [2]

-title: Tyk Streams Http Server Input
+title: Tyk Streams HTTP Server Input
Suggestion importance[1-10]: 8

Why: The suggestion improves the title by correcting the capitalization of "HTTP," ensuring proper acronym usage and maintaining consistency across the documentation. While not critical, it enhances professionalism and readability.

8

Copy link

netlify bot commented Jan 21, 2025

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

Name Link
🔨 Latest commit 28b0567
🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/678f8af21badc20008999a4e
😎 Deploy Preview https://deploy-preview-5912--tyk-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@buger buger merged commit c220a46 into release-5.7 Jan 21, 2025
9 checks passed
@buger buger deleted the merge/release-5.7/5b47bad7a0973ddf21e2fe0fbfc44369bf22642a branch January 21, 2025 11:57
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.

2 participants