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.

Sign up for GitHub

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

Jump to bottom

Docs Template #6167

Draft
wants to merge 8 commits into
base: master
Choose a base branch
from
Draft

Docs Template #6167

wants to merge 8 commits into from

Conversation

sharadregoti
Copy link
Contributor

@sharadregoti sharadregoti commented Mar 17, 2025 •
edited by github-actions bot
Loading

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

Documentation

Description

  • Added glossary link to navigation list

Changes walkthrough 📝

Relevant files
Documentation
menu.yaml
Add glossary entry to menu configuration                                 

tyk-docs/data/menu.yaml

  • Inserted new "Glossary" entry with path /developer-support/glossary
  • Updated menu structure in developer support section
    		• +4/-0     
    Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.
    •

    @buger
    Copy link
    Member

    buger commented Mar 17, 2025

    A JIRA Issue ID is missing from your branch name, PR title and PR description! 🦄

    Your branch: docs-template

    Your PR title: Docs template

    Your PR 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

    If this is your first time contributing to this repository - welcome!

    Please refer to jira-lint to get started.

    Without the JIRA Issue ID in your branch name you would lose out on automatic updates to JIRA via SCM; some GitHub status checks might fail.

    Valid sample branch names:

    ‣ feature/shiny-new-feature--mojo-10'
    ‣ 'chore/changelogUpdate_mojo-123'
    ‣ 'bugfix/fix-some-strange-bug_GAL-2345'

    @github-actions GitHub Actions
    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

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

    Link Verification

    Ensure that the newly added glossary link correctly points to the intended documentation page and follows the same format as other links in the menu.

     
    - title: "Glossary"
  path: /developer-support/glossary
  category: Page
  show: True

    @github-actions GitHub Actions
    Copy link
    Contributor

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    @netlify Netlify
    Copy link

    netlify bot commented Mar 17, 2025 •
    edited
    Loading

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

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

    @buger
    Copy link
    Member

    buger commented Mar 17, 2025

    A JIRA Issue ID is missing from your branch name, PR title and PR description! 🦄

    Your branch: docs-template

    Your PR title: Docs template

    Your PR description: ### **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

    Documentation

    Description

    • Added glossary link to navigation list

    Changes walkthrough 📝

    Relevant files
    Documentation
    menu.yaml
    Add glossary entry to menu configuration                                 

    tyk-docs/data/menu.yaml

  • Inserted new "Glossary" entry with path /developer-support/glossary
  • Updated menu structure in developer support section
    		• +4/-0     
    Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.

    • If this is your first time contributing to this repository - welcome!

    Please refer to jira-lint to get started.

    Without the JIRA Issue ID in your branch name you would lose out on automatic updates to JIRA via SCM; some GitHub status checks might fail.

    Valid sample branch names:

    ‣ feature/shiny-new-feature--mojo-10'
    ‣ 'chore/changelogUpdate_mojo-123'
    ‣ 'bugfix/fix-some-strange-bug_GAL-2345'

    @buger
    Copy link
    Member

    buger commented Mar 17, 2025

    A JIRA Issue ID is missing from your branch name, PR title and PR description! 🦄

    Your branch: docs-template

    Your PR title: Docs template

    Your PR description: ### **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

    Documentation

    Description

    • Added glossary link to navigation list

    Changes walkthrough 📝

    Relevant files
    Documentation
    menu.yaml
    Add glossary entry to menu configuration                                 

    tyk-docs/data/menu.yaml

  • Inserted new "Glossary" entry with path /developer-support/glossary
  • Updated menu structure in developer support section
    		• +4/-0     
    Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.

    • If this is your first time contributing to this repository - welcome!

    Please refer to jira-lint to get started.

    Without the JIRA Issue ID in your branch name you would lose out on automatic updates to JIRA via SCM; some GitHub status checks might fail.

    Valid sample branch names:

    ‣ feature/shiny-new-feature--mojo-10'
    ‣ 'chore/changelogUpdate_mojo-123'
    ‣ 'bugfix/fix-some-strange-bug_GAL-2345'

    @buger
    Copy link
    Member

    buger commented Mar 18, 2025

    A JIRA Issue ID is missing from your branch name, PR title and PR description! 🦄

    Your branch: docs-template

    Your PR title: Docs template

    Your PR description: ### **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

    Documentation

    Description

    • Added glossary link to navigation list

    Changes walkthrough 📝

    Relevant files
    Documentation
    menu.yaml
    Add glossary entry to menu configuration                                 

    tyk-docs/data/menu.yaml

  • Inserted new "Glossary" entry with path /developer-support/glossary
  • Updated menu structure in developer support section
    		• +4/-0     
    Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.

    • If this is your first time contributing to this repository - welcome!

    Please refer to jira-lint to get started.

    Without the JIRA Issue ID in your branch name you would lose out on automatic updates to JIRA via SCM; some GitHub status checks might fail.

    Valid sample branch names:

    ‣ feature/shiny-new-feature--mojo-10'
    ‣ 'chore/changelogUpdate_mojo-123'
    ‣ 'bugfix/fix-some-strange-bug_GAL-2345'

    @buger
    Copy link
    Member

    buger commented Mar 18, 2025

    A JIRA Issue ID is missing from your branch name, PR title and PR description! 🦄

    Your branch: docs-template

    Your PR title: Docs template

    Your PR description: ### **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

    Documentation

    Description

    • Added glossary link to navigation list

    Changes walkthrough 📝

    Relevant files
    Documentation
    menu.yaml
    Add glossary entry to menu configuration                                 

    tyk-docs/data/menu.yaml

  • Inserted new "Glossary" entry with path /developer-support/glossary
  • Updated menu structure in developer support section
    		• +4/-0     
    Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.

    • If this is your first time contributing to this repository - welcome!

    Please refer to jira-lint to get started.

    Without the JIRA Issue ID in your branch name you would lose out on automatic updates to JIRA via SCM; some GitHub status checks might fail.

    Valid sample branch names:

    ‣ feature/shiny-new-feature--mojo-10'
    ‣ 'chore/changelogUpdate_mojo-123'
    ‣ 'bugfix/fix-some-strange-bug_GAL-2345'

    @buger
    Copy link
    Member

    buger commented Mar 18, 2025

    A JIRA Issue ID is missing from your branch name, PR title and PR description! 🦄

    Your branch: docs-template

    Your PR title: Docs template

    Your PR description: ### **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

    Documentation

    Description

    • Added glossary link to navigation list

    Changes walkthrough 📝

    Relevant files
    Documentation
    menu.yaml
    Add glossary entry to menu configuration                                 

    tyk-docs/data/menu.yaml

  • Inserted new "Glossary" entry with path /developer-support/glossary
  • Updated menu structure in developer support section
    		• +4/-0     
    Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.

    • If this is your first time contributing to this repository - welcome!

    Please refer to jira-lint to get started.

    Without the JIRA Issue ID in your branch name you would lose out on automatic updates to JIRA via SCM; some GitHub status checks might fail.

    Valid sample branch names:

    ‣ feature/shiny-new-feature--mojo-10'
    ‣ 'chore/changelogUpdate_mojo-123'
    ‣ 'bugfix/fix-some-strange-bug_GAL-2345'

    @sharadregoti sharadregoti changed the title Docs template Docs Template Mar 18, 2025
    @sharadregoti sharadregoti marked this pull request as draft March 18, 2025 13:11
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers
    No reviews
    Assignees
    No one assigned
    Labels
    Review effort 1/5
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    2 participants
    @sharadregoti @buger