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 - Update the getting started pages #5687

Merged
merged 24 commits into from
Nov 25, 2024

Conversation

DavidRollins
Copy link
Collaborator

@DavidRollins DavidRollins commented Oct 31, 2024

User description

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



Preview Link

https://deploy-preview-5687--tyk-docs.netlify.app/docs/nightly/getting-started/create-account
https://deploy-preview-5687--tyk-docs.netlify.app/docs/nightly/getting-started/configure-first-api
https://deploy-preview-5687--tyk-docs.netlify.app/docs/nightly/getting-started/using-tyk-dashboard

Description

  1. Describe your changes in detail. Why is this change required? What problem does it solve?
    Update the Getting started section with how to create an account, how to configure your first api, and how to use the tyk dashboard pages. This will tutorialize the basic usage of Tyk for a new user.

    1. Please explain the change to the reviewer. Pay special attention to changes that are hard to spot,
      for example:
      2.1. Add the three pages to the menu.yaml
      2.2. Develop the content for the tutorial pages
    2. @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 comprehensive documentation for new users to get started with Tyk, including creating an account, configuring the first API, and using the Tyk Dashboard.
  • Updated the menu configuration to include links to the new getting started guides.
  • Enhanced user onboarding experience by providing detailed, step-by-step guides with examples and visuals.

Changes walkthrough 📝

Relevant files
Documentation
configure-first-api.md
Add guide for configuring the first API in Tyk Cloud         

tyk-docs/content/getting-started/configure-first-api.md

  • Added a comprehensive guide on configuring the first API in Tyk Cloud.
  • Included steps for creating a project, generating API keys, and
    monitoring API performance.
  • Provided example payloads and analytics responses for better
    understanding.
  • +163/-0 
    create-account.md
    Add guide for creating a Tyk Cloud account                             

    tyk-docs/content/getting-started/create-account.md

  • Introduced a guide for creating a Tyk Cloud account.
  • Detailed steps for account creation and verification.
  • Explained the next steps after account setup.
  • +90/-0   
    using-tyk-dashboard.md
    Add guide for using the Tyk Dashboard                                       

    tyk-docs/content/getting-started/using-tyk-dashboard.md

  • Added a guide on using the Tyk Dashboard.
  • Described the dashboard organization and key features.
  • Provided insights into API management, security, and monitoring.
  • +102/-0 
    Configuration changes
    menu.yaml
    Update menu with new getting started pages                             

    tyk-docs/data/menu.yaml

  • Updated the menu to include new getting started pages.
  • Added entries for creating an account, configuring the first API, and
    using the Tyk Dashboard.
  • +12/-0   

    💡 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 Clarity
    The document contains several placeholders for images that are not included in the PR. Ensure that all referenced images are available and correctly linked to avoid broken resources in the documentation.

    Content Structure
    The document provides a detailed walkthrough of the Tyk Dashboard. However, it might benefit from a more structured approach, such as including a table of contents or clearer section headers to enhance readability and navigation.

    Copy link
    Contributor

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    Copy link

    netlify bot commented Oct 31, 2024

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

    Name Link
    🔨 Latest commit f891d72
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/67442b2ba43d99000920d64c
    😎 Deploy Preview https://deploy-preview-5687--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.

    tyk-docs/content/getting-started/create-account.md Outdated Show resolved Hide resolved
    tyk-docs/content/getting-started/create-account.md Outdated Show resolved Hide resolved
    tyk-docs/content/getting-started/create-account.md Outdated Show resolved Hide resolved
    tyk-docs/content/getting-started/create-account.md Outdated Show resolved Hide resolved
    tyk-docs/content/getting-started/configure-first-api.md Outdated Show resolved Hide resolved
    tyk-docs/content/getting-started/configure-first-api.md Outdated Show resolved Hide resolved
    tyk-docs/content/getting-started/configure-first-api.md Outdated Show resolved Hide resolved
    tyk-docs/data/menu.yaml Outdated Show resolved Hide resolved
    @sharadregoti sharadregoti changed the title Update the getting started pages New IA - Update the getting started pages Nov 14, 2024
    @sharadregoti sharadregoti merged commit 766d22b into master Nov 25, 2024
    9 checks passed
    @sharadregoti sharadregoti deleted the getting_started_pages_new_IA branch November 25, 2024 07:49
    @sharadregoti
    Copy link
    Contributor

    /release to release-5.6

    Copy link

    tykbot bot commented Nov 25, 2024

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

    tykbot bot pushed a commit that referenced this pull request Nov 25, 2024
    Co-authored-by: Master <[email protected]>
    (cherry picked from commit 766d22b)
    Copy link

    tykbot bot commented Nov 25, 2024

    @sharadregoti Succesfully merged PR

    buger added a commit that referenced this pull request Nov 25, 2024
    )
    
    New IA - Update the getting started pages (#5687)
    
    Co-authored-by: Master <[email protected]>
    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.

    3 participants