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

Backstage entity provider [DX-1767] #5711

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

Conversation

davegarvey
Copy link
Member

@davegarvey davegarvey commented Nov 13, 2024

User description

Preview Link

https://deploy-preview-5711--tyk-docs.netlify.app/docs/nightly/api-management/automations/#synchronizing-tyk-environment-with-backstage

Description

Moving docs from the Backstage Entity Provider repo into the main Tyk Docs repo.

https://github.com/TykTechnologies/backstage-tyk-entity-provider/blob/main/plugins/catalog-backend-module-tyk/README.md

The product repo is private, so the docs cannot be seen by external users. Adding the documentation here will enable end users to view the documentation.


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

  • Moved documentation from the Backstage Entity Provider repo to the main Tyk Docs repo.
  • Updated numerous documentation links to point to a new "Automations" section.
  • Added a new "Automations" entry to the menu configuration.
  • Improved consistency and accessibility of documentation by centralizing links.

Changes walkthrough 📝

Relevant files
Configuration changes
1 files
menu.yaml
Add "Automations" entry to the menu configuration               

tyk-docs/data/menu.yaml

  • Added a new menu entry for "Automations".
  • Set the path for the new entry to /api-management/automations.
  • +4/-240 
    Documentation
    14 files
    operator-1.0.md
    Update Tyk Operator documentation links to new section     

    tyk-docs/content/product-stack/tyk-operator/release-notes/operator-1.0.md

  • Updated links to point to the new "Automations" section.
  • Adjusted references for installation and upgrade instructions.
  • +7/-7     
    version-5.1.md
    Update Tyk Sync documentation links in release notes         

    tyk-docs/content/product-stack/tyk-dashboard/release-notes/version-5.1.md

    • Updated Tyk Sync links to point to the new "Automations" section.
    +2/-2     
    api-categories.md
    Update Tyk Operator link in API categories documentation 

    tyk-docs/content/product-stack/tyk-dashboard/advanced-configurations/api-categories.md

  • Updated Tyk Operator link to point to the new "Automations" section.
  • +2/-2     
    version-1.5.md
    Update Tyk Operator installation guide links in release notes

    tyk-docs/content/product-stack/tyk-charts/release-notes/version-1.5.md

  • Updated Tyk Operator installation guide links to the new "Automations"
    section.
  • +2/-2     
    apim.md
    Update Version Control integration link in APIM documentation

    tyk-docs/content/apim.md

  • Updated Version Control integration link to point to the new
    "Automations" section.
  • +1/-1     
    tyk-oss-chart.md
    Update Tyk Operator installation guide links in OSS chart
    documentation

    tyk-docs/content/product-stack/tyk-charts/tyk-oss-chart.md

  • Updated Tyk Operator installation guide links to the new "Automations"
    section.
  • +2/-2     
    version-2.1.md
    Update Tyk Operator installation and upgrade links in release notes

    tyk-docs/content/product-stack/tyk-charts/release-notes/version-2.1.md

  • Updated Tyk Operator installation and upgrade instructions links to
    the new "Automations" section.
  • +1/-1     
    operator-0.17.md
    Update Tyk Operator upgrade instructions links in release notes

    tyk-docs/content/product-stack/tyk-operator/release-notes/operator-0.17.md

  • Updated upgrade instructions links to the new "Automations" section.
  • +2/-2     
    tyk-control-plane-chart.md
    Update Tyk Operator installation guide links in control plane chart
    documentation

    tyk-docs/content/product-stack/tyk-charts/tyk-control-plane-chart.md

  • Updated Tyk Operator installation guide links to the new "Automations"
    section.
  • +2/-2     
    tyk-stack-chart.md
    Update Tyk Operator installation guide links in stack chart
    documentation

    tyk-docs/content/product-stack/tyk-charts/tyk-stack-chart.md

  • Updated Tyk Operator installation guide links to the new "Automations"
    section.
  • +2/-2     
    deploy-apis-overview.md
    Update Tyk Sync and Tyk Operator links in deploy APIs overview

    tyk-docs/content/api-management/manage-apis/deploy-apis/deploy-apis-overview.md

  • Updated Tyk Sync and Tyk Operator links to point to the new
    "Automations" section.
  • +2/-2     
    kubernetes-ingress.md
    Update Ingress Controller link in Kubernetes ingress documentation

    tyk-docs/content/tyk-on-prem/kubernetes-ingress.md

  • Updated Ingress Controller link to point to the new "Automations"
    section.
  • +2/-1     
    version-1.4.md
    Update Tyk Operator installation link in release notes     

    tyk-docs/content/product-stack/tyk-charts/release-notes/version-1.4.md

  • Updated Tyk Operator installation link to the new "Automations"
    section.
  • +1/-1     
    version-5.3.md
    Update Tyk Sync link in release notes                                       

    tyk-docs/content/product-stack/tyk-dashboard/release-notes/version-5.3.md

    • Updated Tyk Sync link to point to the new "Automations" section.
    +1/-1     
    Additional files (token-limit)
    1 files
    automations.md
    ...                                                                                                           

    tyk-docs/content/api-management/automations.md

    ...

    +5181/-1

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

    Copy link

    netlify bot commented Nov 13, 2024

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

    Name Link
    🔨 Latest commit 2cbbf6f
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/673489c8c2076100084a290d
    😎 Deploy Preview https://deploy-preview-5711--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.

    1 similar comment
    Copy link

    netlify bot commented Nov 13, 2024

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

    Name Link
    🔨 Latest commit 2cbbf6f
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/673489c8c2076100084a290d
    😎 Deploy Preview https://deploy-preview-5711--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.

    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

    Documentation Structure
    Ensure that the new menu items added are correctly structured and linked within the site's navigation hierarchy.

    License Information
    The update to the license requirement for Tyk Operator should be clearly documented and visible to users to avoid any confusion or operational issues.

    Feature Documentation
    The documentation for new features such as Tyk Sync needs to be comprehensive to ensure users can fully utilize these features without confusion.

    Copy link
    Contributor

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    @davegarvey davegarvey marked this pull request as draft November 13, 2024 12:33
    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