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

[DX-230] handle special chars in headings #6211

Merged
merged 6 commits into from
Mar 25, 2025
Merged

[DX-230] handle special chars in headings #6211

merged 6 commits into from
Mar 25, 2025

Conversation

letzya
Copy link
Collaborator

@letzya letzya commented Mar 25, 2025

User description

Preview Link

Checklist

  • Added a preview link
  • Reviewed AI PR Agent suggestions
  • For Tyk Members - Added Jira DX PR ticket to the subject
  • For Tyk Members - Added the appropriate release labels (for fixes add the latest release)

New Contributors


PR Type

  • Enhancement

Description

  • Add unique anchor IDs to headings.

  • Update URL references for consistency.

  • Enhance internal document linking.


Changes walkthrough 📝

Relevant files
Enhancement
release-notes-condensed-template.md
Anchor ID added to condensed release notes template.         

tyk-docs/assets/others/release-notes-condensed-template.md

  • Added anchor ID to 3rd Party Dependencies heading.
+1/-1     
release-notes-learner-template.md
Anchor ID added to learner release notes template.             

tyk-docs/assets/others/release-notes-learner-template.md

  • Added anchor ID to 3rd Party Dependencies heading.
+1/-1     
rich-plugins.md
Anchor ID added to rich plugins header.                                   

tyk-docs/content/api-management/plugins/rich-plugins.md

  • Added anchor ID to ID Extractor & Auth Plugins header.
+1/-1     
upgrading.md
Update anchor links in upgrade guide.                                       

tyk-docs/content/developer-support/upgrading.md

  • Updated anchor links for Linux upgrade sections.
  • Revised reference URLs for RPM/DEB guides.
  • +6/-6     
    tyk-self-managed.md
    Update self managed anchor references.                                     

    tyk-docs/content/tyk-self-managed.md

  • Updated badge link for Red Hat install.
  • Added anchor ID to installation header.
  • +3/-3     

    Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.
  • Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

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

    Ref Syntax

    The new ref link for the Debian and Ubuntu guide uses "##upgrade-linux-debian" with an extra '#' that might break the expected anchor linking. Please verify that the correct ref syntax is used for consistent behavior.

    |                      | [Debian and Ubuntu]({{< ref "##upgrade-linux-debian" >}}) | Guide for DEB-based Linux distributions |

    Copy link
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Impact
    Possible issue
    Fix double hash link

    Replace the double-hash reference with a single-hash to ensure the link correctly
    targets the intended heading.

    tyk-docs/content/developer-support/upgrading.md [74]

    -|                      | [Debian and Ubuntu]({{< ref "##upgrade-linux-debian" >}}) | Guide for DEB-based Linux distributions |
    +|                      | [Debian and Ubuntu]({{< ref "#upgrade-linux-debian" >}}) | Guide for DEB-based Linux distributions |
    Suggestion importance[1-10]: 7

    __

    Why: The suggestion correctly fixes a potential broken link by replacing the double-hash reference with a single-hash, ensuring the link targets the intended heading; while important for functionality, the change is relatively minor, hence a moderate score.

    Medium

    Copy link

    netlify bot commented Mar 25, 2025

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

    Name Link
    🔨 Latest commit d9d5b04
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/67e2bd844f277400085013c2
    😎 Deploy Preview https://deploy-preview-6211--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.

    Copy link

    netlify bot commented Mar 25, 2025

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

    Name Link
    🔨 Latest commit 684886f
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/67e2cb14c5342b00076dc73e
    😎 Deploy Preview https://deploy-preview-6211--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.

    @letzya letzya requested a review from yurisasuke March 25, 2025 14:41
    @letzya letzya enabled auto-merge (squash) March 25, 2025 17:29
    @letzya letzya disabled auto-merge March 25, 2025 17:38
    @letzya letzya merged commit 5602140 into master Mar 25, 2025
    12 checks passed
    @letzya letzya deleted the letz-ampersand branch March 25, 2025 17:38
    @sharadregoti
    Copy link
    Contributor

    /release to release-5.7

    Copy link

    tykbot bot commented Mar 25, 2025

    Working on it! Note that it can take a few minutes.

    tykbot bot pushed a commit that referenced this pull request Mar 25, 2025
    * handle special chars in headings
    
    * skip test for a few urls
    
    * fix anchor ref
    
    * fix alias.json with updatd fragments
    
    * more files
    
    * fix fragment links
    
    (cherry picked from commit 5602140)
    Copy link

    tykbot bot commented Mar 25, 2025

    @sharadregoti Succesfully merged PR

    buger added a commit that referenced this pull request Mar 25, 2025
    )
    
    [DX-230] handle special chars in headings (#6211)
    
    * handle special chars in headings
    
    * skip test for a few urls
    
    * fix anchor ref
    
    * fix alias.json with updatd fragments
    
    * more files
    
    * fix fragment links
    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