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

New IA - Overview pages #5700

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

New IA - Overview pages #5700

wants to merge 10 commits into from

Conversation

DavidRollins
Copy link
Collaborator

@DavidRollins DavidRollins commented Nov 7, 2024

User description

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



Preview Link


Description

  1. Describe your changes in detail. Why is this change required? What problem does it solve?
    2. Please explain the change to the reviewer. Pay special attention to changes that are hard to spot
    2.1. Update overview section with overview pages:
    2.1.1 Tyk Overview - introduction to Tyk and the problems Tyk looks to help businesses solve
    2.1.2 Tyk Components - What makes up Tyk and intro to how they work
    2.1.3 Planning phase details - centralizing planning your API
    3. @mentions of the person to review the proposed changes. They need to be able to know the topic well in order to approve it.

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

  • Added new documentation pages for Tyk Overview, Tyk Components, and Plan Your API Integration.
  • The new pages provide detailed information on Tyk's API management capabilities and components.
  • Updated the menu configuration to include links to the new overview pages.

Changes walkthrough 📝

Relevant files
Documentation
plan-your-api-integration.md
Add detailed guide for planning API integration                   

tyk-docs/content/plan-your-api-integration.md

  • Added a comprehensive guide on planning API integration with Tyk.
  • Included sections on API purpose, design, documentation, development,
    deployment, and monitoring.
  • Highlighted Tyk's support for various API lifecycle stages.
  • +113/-0 
    tyk-components.md
    Introduce and explain Tyk's API management components       

    tyk-docs/content/tyk-components.md

  • Introduced Tyk's API management components.
  • Detailed the roles of each component in API management.
  • Provided links to further documentation for each component.
  • +216/-0 
    tyk-overview.md
    Provide an overview of Tyk's API management                           

    tyk-docs/content/tyk-overview.md

  • Provided an overview of Tyk's API management capabilities.
  • Explained the need for API management and Tyk's solutions.
  • Described how Tyk's components work together.
  • +67/-0   
    Configuration changes
    menu.yaml
    Update menu to include new overview pages                               

    tyk-docs/data/menu.yaml

  • Updated menu structure to include new overview pages.
  • Added links to Tyk Overview, Tyk Components, and Plan Your API
    Integration.
  • +17/-0   

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

    Copy link
    Contributor

    github-actions bot commented Nov 7, 2024

    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 Clarity
    The document is very comprehensive but could benefit from more concise language and possibly graphical representations to break down complex information, especially in the steps sections.

    Detailed Descriptions
    Ensure that the descriptions of each component are not too verbose which might overwhelm new users. Consider simplifying the language or using bullet points for features.

    Integration Detail
    The section on Tyk's integration with other systems like Kubernetes, Docker, and cloud platforms needs more specific examples or case studies to illustrate these integrations.

    Copy link
    Contributor

    github-actions bot commented Nov 7, 2024

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    Copy link

    netlify bot commented Nov 7, 2024

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

    Name Link
    🔨 Latest commit 82e19bf
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/67407ffd084dbf0008105889
    😎 Deploy Preview https://deploy-preview-5700--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 Overview pages New IA - Overview pages Nov 14, 2024
    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