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

Update Home Page #5747

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update Home Page #5747

wants to merge 2 commits into from

Conversation

sharadregoti
Copy link
Contributor

@sharadregoti sharadregoti commented Nov 22, 2024

User description

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



Preview Link

https://deploy-preview-5747--tyk-docs.netlify.app/docs/nightly/

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

enhancement, documentation


Description

  • Updated the tyk_components.json file to enhance the descriptions and titles of the Tyk components for better clarity and focus on guided evaluation and trial processes.
  • Modified button texts to better align with the new descriptions and user actions.
  • Removed unnecessary steps information to streamline the component details.

Changes walkthrough 📝

Relevant files
Enhancement
tyk_components.json
Update component descriptions and titles for improved clarity

tyk-docs/data/tyk_components.json

  • Updated the title and description for "Tyk Self Managed" to focus on
    guided evaluation.
  • Changed button text for "Tyk Self Managed" and "Tyk Cloud" components.
  • Removed steps information from components.
  • Enhanced descriptions to emphasize evaluation and trial processes.
  • +12/-22 

    💡 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: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Content Consistency
    The new entries for "Schedule your guided evaluation" and "Tyk Cloud" in the JSON file lack detailed steps compared to previous entries which included specific steps and detailed descriptions. This inconsistency might affect user expectations and clarity.

    Copy link
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    General
    Populate or remove the empty "steps" field to enhance data quality

    Ensure that the "steps" field in each component object is populated with meaningful
    content or removed if not necessary.

    tyk-docs/data/tyk_components.json [6]

    -"steps": "",
    +"steps": "Complete the form to get started",
    Suggestion importance[1-10]: 5

    Why: The suggestion to populate the "steps" field with meaningful content or remove it if unnecessary is relevant as it addresses the quality of data in the JSON file. However, the specific content "Complete the form to get started" may not be universally applicable to all components, hence a moderate score.

    5

    Copy link

    netlify bot commented Nov 22, 2024

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

    Name Link
    🔨 Latest commit 082a73a
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/67408425a060ec000833801a
    😎 Deploy Preview https://deploy-preview-5747--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.

    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