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

explain bootstrapping process #5742

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

explain bootstrapping process #5742

wants to merge 5 commits into from

Conversation

caroltyk
Copy link
Contributor

@caroltyk caroltyk commented Nov 21, 2024

User description

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



Preview Link


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

documentation


Description

  • Added a new section in the documentation to explain the bootstrapping process for Tyk stack chart.
  • Described the default behavior of the bootstrapping job, including the verification of a dashboard license and preparation of key components.
  • Provided guidance on disabling the bootstrapping process and troubleshooting failures by reviewing logs from bootstrap pods.

Changes walkthrough 📝

Relevant files
Documentation
tyk-stack-chart.md
Add documentation for bootstrapping process in Tyk stack chart

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

  • Added a section explaining the bootstrapping process.
  • Described the default behavior of the bootstrapping job.
  • Provided instructions for handling bootstrapping failures.
  • +8/-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: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Clarity Improvement
    The description of the bootstrapping process could be enhanced by providing more detailed information about what exactly is being set up during the bootstrapping and why these components are critical. This would help users understand the importance of each step and the potential impact of disabling the bootstrapping.

    Copy link
    Contributor

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    Copy link

    netlify bot commented Nov 21, 2024

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

    Name Link
    🔨 Latest commit ab0e01a
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/674073452ec71300083f2e53
    😎 Deploy Preview https://deploy-preview-5742--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