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

Removed Tyk Prefix from Menu Titles #5604

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

sharadregoti
Copy link
Contributor

@sharadregoti sharadregoti commented Oct 15, 2024

User description

For internal users - Please add a Jira DX PR ticket to the subject!



Preview Link


Description


Screenshots (if appropriate)


Checklist

  • I have added a preview link to the PR description.
  • I have reviewed the suggestions made by our AI (PR Agent) and updated them accordingly (spelling errors, rephrasing, etc.)
  • I have reviewed the guidelines for contributing to this repository.
  • I have read the technical guidelines for contributing to this repository.
  • Make sure you have started your change off our latest master.
  • I labeled the PR

PR Type

documentation


Description

  • Removed the 'Tyk' prefix from menu titles across the documentation to enhance readability and consistency.
  • Updated titles in various sections such as API Gateway, Cloud Platform, and Dashboard.
  • This change affects the navigation structure, making it more user-friendly.

Changes walkthrough 📝

Relevant files
Documentation
menu.yaml
Simplified Menu Titles by Removing 'Tyk' Prefix                   

tyk-docs/data/menu.yaml

  • Removed the 'Tyk' prefix from various menu titles.
  • Updated titles to be more concise and consistent.
  • Affected multiple sections, including API Gateway, Cloud Platform, and
    Dashboard.
  • +166/-166

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

    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

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

    Consistency Check
    Ensure that the removal of the "Tyk" prefix and other terminology changes maintain consistency across all documentation and do not affect the clarity or discoverability of information.

    Copy link
    Contributor

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    Copy link

    netlify bot commented Oct 15, 2024

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

    Name Link
    🔨 Latest commit 407a52e
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/670e493f169ed80008b04cff
    😎 Deploy Preview https://deploy-preview-5604--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.

    @@ -1885,11 +1885,11 @@ menu:
    path: /product-stack/tyk-gateway/advanced-configurations/api-versioning/api-versioning
    category: Page
    show: True
    - title: "Tyk OAS versioning"
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    Here we can't do that. Without it the name is too confusing

    path: /product-stack/tyk-gateway/advanced-configurations/plugins/bundles/oas
    category: Page
    show: True
    - title: "Tyk Classic configuration"
    - title: "Classic configuration"
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    might be too confusing here as well

    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