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-1782] Fix Licensing Page #5906

Merged
merged 4 commits into from
Jan 21, 2025
Merged

[DX-1782] Fix Licensing Page #5906

merged 4 commits into from
Jan 21, 2025

Conversation

sharadregoti
Copy link
Contributor

@sharadregoti sharadregoti commented Jan 21, 2025

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, Enhancement


Description

  • Updated licensing section to simplify and streamline content.

  • Added new configuration options in config.toml.

  • Updated alias for licensing in alias.json.


Changes walkthrough 📝

Relevant files
Configuration changes
config.toml
Added new configuration options for reference links           

tyk-docs/config.toml

  • Added refLinksErrorLevel configuration with "WARNING".
  • Added refLinksNotFoundURL configuration with an empty string.
  • +2/-0     
    Documentation
    tyk-self-managed.md
    Simplified and streamlined licensing documentation             

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

  • Simplified licensing section by removing detailed deployment models.
  • Updated section title to "Tyk Self Managed License/Pricing".
  • Added reference to pricing page for further details.
  • +2/-55   
    alias.json
    Updated alias for licensing section                                           

    tyk-docs/data/alias.json

    • Updated alias for licensing to match new section title.
    +1/-1     

    💡 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

    Content Simplification

    The new section Tyk Self Managed License/Pricing significantly simplifies the previous detailed explanation about licensing and deployment models. Ensure that this simplification does not omit critical information that users might need for decision-making.

    ### Tyk Self Managed License/Pricing
    
    Refer the [pricing page](https://tyk.io/pricing/)
    Alias Update

    The alias for tyk-on-premises/licensing has been updated to point to a new section. Verify that this change aligns with the intended navigation and does not break existing references.

    "tyk-on-premises/licensing": "#tyk-self-managed-licensepricing",

    Copy link
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    General
    Improve link context for accessibility

    Ensure the link to the pricing page is descriptive and provides context for users,
    such as explaining what they can expect to find on the page, to improve
    accessibility and user experience.

    tyk-docs/content/tyk-self-managed.md [135]

    -Refer the [pricing page](https://tyk.io/pricing/)
    +Refer to the [pricing page](https://tyk.io/pricing/) for detailed information on Tyk Self-Managed licensing and pricing options.
    Suggestion importance[1-10]: 5

    Why: The suggestion enhances the link's context, making it more descriptive and improving accessibility and user experience. However, the improvement is relatively minor and does not address a critical issue.

    5

    Copy link

    netlify bot commented Jan 21, 2025

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

    Name Link
    🔨 Latest commit 8abcfc9
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/678f8884b1ee230008cfd025
    😎 Deploy Preview https://deploy-preview-5906--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.

    @sharadregoti sharadregoti changed the title Fix Licensing Page [DX-1782] Fix Licensing Page Jan 21, 2025
    @sharadregoti sharadregoti merged commit 49ec851 into master Jan 21, 2025
    9 checks passed
    @sharadregoti sharadregoti deleted the fix-licensing-page branch January 21, 2025 11:49
    @sharadregoti
    Copy link
    Contributor Author

    /release to release-5.7

    Copy link

    tykbot bot commented Jan 21, 2025

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

    tykbot bot pushed a commit that referenced this pull request Jan 21, 2025
    (cherry picked from commit 49ec851)
    Copy link

    tykbot bot commented Jan 21, 2025

    @sharadregoti Succesfully merged PR

    buger added a commit that referenced this pull request Jan 21, 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.

    1 participant